libtelepathy/tsrc/src/telepathy-presence.c
changeset 10 59927b2d3b75
parent 0 d0f3a028347a
equal deleted inserted replaced
0:d0f3a028347a 10:59927b2d3b75
     1 /*
       
     2 * Copyright (c) 2008 - 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of the License "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:    Used for Presence related Test Cases
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 //#include "config.h"
       
    22 
       
    23 #include <string.h>
       
    24 #include "telepathy-presence.h"
       
    25 //#include "telepathy-time.h"
       
    26 
       
    27 //#include <glib/gi18n.h> //below code is replacement of this header
       
    28 //+++++++++++++++++++++++++++++++++++++++++++++++++
       
    29 #include <glib/gstrfuncs.h>
       
    30 
       
    31 #define _(String) gettext (String)
       
    32 #define Q_(String) g_strip_context ((String), gettext (String))
       
    33 #ifdef gettext_noop
       
    34 #define N_(String) gettext_noop (String)
       
    35 #else
       
    36 #define N_(String) (String)
       
    37 #endif
       
    38 //++++++++++++++++++++++++++++++++++++++++++++++++++
       
    39 
       
    40 
       
    41 
       
    42 
       
    43 #define GET_PRIV(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), TELEPATHY_TYPE_PRESENCE, TelepathyPresencePriv))
       
    44 
       
    45 
       
    46 typedef long TelepathyTime;         /* Note: Always in UTC. */
       
    47 typedef struct _TelepathyPresencePriv TelepathyPresencePriv;
       
    48 
       
    49 struct _TelepathyPresencePriv {
       
    50 	TelepathyPresenceState  state;
       
    51 
       
    52 	gchar               *status;
       
    53 	gchar               *resource;
       
    54 
       
    55 	gint                 priority;
       
    56 	TelepathyTime           timestamp;
       
    57 };
       
    58 
       
    59 static void         presence_finalize           (GObject             *object);
       
    60 static void         presence_get_property       (GObject             *object,
       
    61 						 guint                param_id,
       
    62 						 GValue              *value,
       
    63 						 GParamSpec          *pspec);
       
    64 static void         presence_set_property       (GObject             *object,
       
    65 						 guint                param_id,
       
    66 						 const GValue        *value,
       
    67 						 GParamSpec          *pspec);
       
    68 
       
    69 enum {
       
    70 	PROP_0,
       
    71 	PROP_STATE,
       
    72 	PROP_STATUS,
       
    73 	PROP_RESOURCE,
       
    74 	PROP_PRIORITY
       
    75 };
       
    76 
       
    77 G_DEFINE_TYPE (TelepathyPresence, telepathy_presence, G_TYPE_OBJECT);
       
    78 
       
    79 TelepathyTime
       
    80 telepathy_time_get_current (void)
       
    81 {
       
    82 	return time (NULL);
       
    83 }
       
    84 
       
    85 static void
       
    86 telepathy_presence_class_init (TelepathyPresenceClass *class)
       
    87 {
       
    88 	GObjectClass *object_class;
       
    89 
       
    90 	object_class = G_OBJECT_CLASS (class);
       
    91 
       
    92 	object_class->finalize     = presence_finalize;
       
    93 	object_class->get_property = presence_get_property;
       
    94 	object_class->set_property = presence_set_property;
       
    95 
       
    96 	g_object_class_install_property (object_class,
       
    97 					 PROP_STATE,
       
    98 					 g_param_spec_int ("state",
       
    99 							   "Presence State",
       
   100 							   "The current state of the presence",
       
   101 							   TELEPATHY_PRESENCE_STATE_AVAILABLE,
       
   102 							   TELEPATHY_PRESENCE_STATE_EXT_AWAY,
       
   103 							   TELEPATHY_PRESENCE_STATE_AVAILABLE,
       
   104 							   G_PARAM_READWRITE));
       
   105 	g_object_class_install_property (object_class,
       
   106 					 PROP_STATUS,
       
   107 					 g_param_spec_string ("status",
       
   108 							      "Presence Status",
       
   109 							      "Status string set on presence",
       
   110 							      NULL,
       
   111 							      G_PARAM_READWRITE));
       
   112 	g_object_class_install_property (object_class,
       
   113 					 PROP_RESOURCE,
       
   114 					 g_param_spec_string ("resource",
       
   115 							      "Presence Resource",
       
   116 							      "Resource that this presence is for",
       
   117 							      NULL,
       
   118 							      G_PARAM_READWRITE));
       
   119 	g_object_class_install_property (object_class,
       
   120 					 PROP_PRIORITY,
       
   121 					 g_param_spec_int ("priority",
       
   122 							   "Presence Priority",
       
   123 							   "Priority value of presence",
       
   124 							   G_MININT,
       
   125 							   G_MAXINT,
       
   126 							   0,
       
   127 							   G_PARAM_READWRITE));
       
   128 
       
   129 	g_type_class_add_private (object_class, sizeof (TelepathyPresencePriv));
       
   130 }
       
   131 
       
   132 static void
       
   133 telepathy_presence_init (TelepathyPresence *presence)
       
   134 {
       
   135 	TelepathyPresencePriv *priv;
       
   136 
       
   137 	priv = GET_PRIV (presence);
       
   138 
       
   139 	priv->state = TELEPATHY_PRESENCE_STATE_AVAILABLE;
       
   140 
       
   141 	priv->status = NULL;
       
   142 	priv->resource = NULL;
       
   143 
       
   144 	priv->priority = 0;
       
   145 
       
   146 	priv->timestamp = telepathy_time_get_current ();
       
   147 }
       
   148 
       
   149 static void
       
   150 presence_finalize (GObject *object)
       
   151 {
       
   152 	TelepathyPresencePriv *priv;
       
   153 
       
   154 	priv = GET_PRIV (object);
       
   155 
       
   156 	g_free (priv->status);
       
   157 	g_free (priv->resource);
       
   158 
       
   159 	(G_OBJECT_CLASS (telepathy_presence_parent_class)->finalize) (object);
       
   160 }
       
   161 
       
   162 static void
       
   163 presence_get_property (GObject    *object,
       
   164 		       guint       param_id,
       
   165 		       GValue     *value,
       
   166 		       GParamSpec *pspec)
       
   167 {
       
   168 	TelepathyPresencePriv *priv;
       
   169 
       
   170 	priv = GET_PRIV (object);
       
   171 
       
   172 	switch (param_id) {
       
   173 	case PROP_STATE:
       
   174 		g_value_set_int (value, priv->state);
       
   175 		break;
       
   176 	case PROP_STATUS:
       
   177 		g_value_set_string (value,
       
   178 				    telepathy_presence_get_status (TELEPATHY_PRESENCE (object)));
       
   179 		break;
       
   180 	case PROP_RESOURCE:
       
   181 		g_value_set_string (value,
       
   182 				    telepathy_presence_get_resource (TELEPATHY_PRESENCE (object)));
       
   183 		break;
       
   184 	case PROP_PRIORITY:
       
   185 		g_value_set_int (value, priv->priority);
       
   186 		break;
       
   187 	default:
       
   188 		G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
       
   189 		break;
       
   190 	}
       
   191 }
       
   192 static void
       
   193 presence_set_property (GObject      *object,
       
   194 		       guint         param_id,
       
   195 		       const GValue *value,
       
   196 		       GParamSpec   *pspec)
       
   197 {
       
   198 	TelepathyPresencePriv *priv;
       
   199 
       
   200 	priv = GET_PRIV (object);
       
   201 
       
   202 	switch (param_id) {
       
   203 	case PROP_STATE:
       
   204 		priv->state = g_value_get_int (value);
       
   205 		break;
       
   206 	case PROP_STATUS:
       
   207 		telepathy_presence_set_status (TELEPATHY_PRESENCE (object),
       
   208 					    g_value_get_string (value));
       
   209 		break;
       
   210 	case PROP_RESOURCE:
       
   211 		telepathy_presence_set_resource (TELEPATHY_PRESENCE (object),
       
   212 					      g_value_get_string (value));
       
   213 		break;
       
   214 	case PROP_PRIORITY:
       
   215 		priv->priority = g_value_get_int (value);
       
   216 		break;
       
   217 	default:
       
   218 		G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
       
   219 		break;
       
   220 	}
       
   221 }
       
   222 
       
   223 TelepathyPresence *
       
   224 telepathy_presence_new (void)
       
   225 {
       
   226 	return g_object_new (TELEPATHY_TYPE_PRESENCE, NULL);
       
   227 }
       
   228 
       
   229 TelepathyPresence *
       
   230 telepathy_presence_new_full (TelepathyPresenceState  state,
       
   231 			  const gchar         *status)
       
   232 {
       
   233 	return g_object_new (TELEPATHY_TYPE_PRESENCE,
       
   234 			     "state", state,
       
   235 			     "status", status,
       
   236 			     NULL);
       
   237 }
       
   238 
       
   239 const gchar *
       
   240 telepathy_presence_get_resource (TelepathyPresence *presence)
       
   241 {
       
   242 	TelepathyPresencePriv *priv;
       
   243 
       
   244 	g_return_val_if_fail (TELEPATHY_IS_PRESENCE (presence), NULL);
       
   245 
       
   246 	priv = GET_PRIV (presence);
       
   247 
       
   248 	if (priv->resource) {
       
   249 		return priv->resource;
       
   250 	}
       
   251 
       
   252 	return NULL;
       
   253 }
       
   254 
       
   255 const gchar *
       
   256 telepathy_presence_get_status (TelepathyPresence *presence)
       
   257 {
       
   258 	TelepathyPresencePriv *priv;
       
   259 
       
   260 	/*g_return_val_if_fail (TELEPATHY_IS_PRESENCE (presence),
       
   261 			      _("Offline"));*/
       
   262 
       
   263 	priv = GET_PRIV (presence);
       
   264 
       
   265 	return priv->status;
       
   266 }
       
   267 
       
   268 gint
       
   269 telepathy_presence_get_priority (TelepathyPresence *presence)
       
   270 {
       
   271 	TelepathyPresencePriv *priv;
       
   272 
       
   273 	priv = GET_PRIV (presence);
       
   274 	g_return_val_if_fail (TELEPATHY_IS_PRESENCE (presence), 0);
       
   275 
       
   276 	return priv->priority;
       
   277 }
       
   278 
       
   279 void
       
   280 telepathy_presence_set_resource (TelepathyPresence *presence,
       
   281 			      const gchar    *resource)
       
   282 {
       
   283 	TelepathyPresencePriv *priv;
       
   284 
       
   285 	g_return_if_fail (TELEPATHY_IS_PRESENCE (presence));
       
   286 	g_return_if_fail (resource != NULL);
       
   287 
       
   288 	priv = GET_PRIV (presence);
       
   289 
       
   290 	g_free (priv->resource);
       
   291 	priv->resource = g_strdup (resource);
       
   292 
       
   293 	g_object_notify (G_OBJECT (presence), "resource");
       
   294 }
       
   295 
       
   296 TelepathyPresenceState
       
   297 telepathy_presence_get_state (TelepathyPresence *presence)
       
   298 {
       
   299 	TelepathyPresencePriv *priv;
       
   300 
       
   301 	g_return_val_if_fail (TELEPATHY_IS_PRESENCE (presence),
       
   302 			      TELEPATHY_PRESENCE_STATE_AVAILABLE);
       
   303 
       
   304 	priv = GET_PRIV (presence);
       
   305 
       
   306 	return priv->state;
       
   307 }
       
   308 
       
   309 void
       
   310 telepathy_presence_set_state (TelepathyPresence      *presence,
       
   311 			   TelepathyPresenceState  state)
       
   312 {
       
   313 	TelepathyPresencePriv *priv;
       
   314 
       
   315 	g_return_if_fail (TELEPATHY_IS_PRESENCE (presence));
       
   316 
       
   317 	priv = GET_PRIV (presence);
       
   318 
       
   319 	priv->state = state;
       
   320 
       
   321 	g_object_notify (G_OBJECT (presence), "state");
       
   322 }
       
   323 
       
   324 void
       
   325 telepathy_presence_set_status (TelepathyPresence *presence,
       
   326 			    const gchar    *status)
       
   327 {
       
   328 	TelepathyPresencePriv *priv;
       
   329 
       
   330 	priv = GET_PRIV (presence);
       
   331 	g_return_if_fail (TELEPATHY_IS_PRESENCE (presence));
       
   332 
       
   333 	g_free (priv->status);
       
   334 
       
   335 	if (status) {
       
   336 		priv->status = g_strdup (status);
       
   337 	} else {
       
   338 		priv->status = NULL;
       
   339 	}
       
   340 
       
   341 	g_object_notify (G_OBJECT (presence), "status");
       
   342 }
       
   343 
       
   344 void
       
   345 telepathy_presence_set_priority (TelepathyPresence *presence,
       
   346 			      gint            priority)
       
   347 {
       
   348 	TelepathyPresencePriv *priv;
       
   349 
       
   350 	g_return_if_fail (TELEPATHY_IS_PRESENCE (presence));
       
   351 
       
   352 	priv = GET_PRIV (presence);
       
   353 
       
   354 	priv->priority = priority;
       
   355 
       
   356 	g_object_notify (G_OBJECT (presence), "priority");
       
   357 }
       
   358 
       
   359 gboolean
       
   360 telepathy_presence_resource_equal (gconstpointer a,
       
   361 				gconstpointer b)
       
   362 {
       
   363 	TelepathyPresencePriv *priv1;
       
   364 	TelepathyPresencePriv *priv2;
       
   365 
       
   366 	g_return_val_if_fail (TELEPATHY_IS_PRESENCE (a), FALSE);
       
   367 	g_return_val_if_fail (TELEPATHY_IS_PRESENCE (b), FALSE);
       
   368 
       
   369 	priv1 = GET_PRIV (a);
       
   370 	priv2 = GET_PRIV (b);
       
   371 
       
   372 	if (!priv1->resource) {
       
   373 		if (!priv2->resource) {
       
   374 			return TRUE;
       
   375 		}
       
   376 
       
   377 		return FALSE;
       
   378 	}
       
   379 
       
   380 	if (!priv2->resource) {
       
   381 		return FALSE;
       
   382 	}
       
   383 
       
   384 	if (strcmp (priv1->resource, priv2->resource) == 0) {
       
   385 		return TRUE;
       
   386 	}
       
   387 
       
   388 	return FALSE;
       
   389 }
       
   390 
       
   391 gint
       
   392 telepathy_presence_sort_func (gconstpointer a,
       
   393 			   gconstpointer b)
       
   394 {
       
   395 	TelepathyPresencePriv *priv_a;
       
   396 	TelepathyPresencePriv *priv_b;
       
   397 	gint                diff;
       
   398 
       
   399 	g_return_val_if_fail (TELEPATHY_IS_PRESENCE (a), 0);
       
   400 	g_return_val_if_fail (TELEPATHY_IS_PRESENCE (b), 0);
       
   401 
       
   402 	/* We sort here by priority AND status, in theory, the
       
   403 	 * priority would be enough for JUST Jabber contacts which
       
   404 	 * actually abide to the protocol, but for other protocols and
       
   405 	 * dodgy clients, we will sort by:
       
   406 	 *   
       
   407 	 *    1. State
       
   408 	 *    2. Priority
       
   409 	 *    3. Time it was set (most recent first).
       
   410 	 */
       
   411 	 
       
   412 	priv_a = GET_PRIV (a);
       
   413 	priv_b = GET_PRIV (b);
       
   414 
       
   415 	/* 1. State */
       
   416 	diff = priv_a->state - priv_b->state;
       
   417 	if (diff != 0) {
       
   418 		return diff < 1 ? -1 : +1;
       
   419 	}
       
   420 
       
   421 	/* 2. Priority */
       
   422 	diff = priv_a->priority - priv_b->priority;
       
   423 	if (diff != 0) {
       
   424 		return diff < 1 ? -1 : +1;
       
   425 	}
       
   426 
       
   427 	/* 3. Time (newest first) */
       
   428 	diff = priv_b->timestamp - priv_a->timestamp;
       
   429 	if (diff != 0) {
       
   430 		return diff < 1 ? -1 : +1;
       
   431 	}
       
   432 		
       
   433 	/* No real difference, except maybe resource */
       
   434 	return 0;
       
   435 }
       
   436 
       
   437 
       
   438 /*static*/ const gchar *
       
   439 telepathy_presence_state_to_str (TelepathyPresenceState presence_state)
       
   440 {
       
   441 	switch (presence_state) {
       
   442 	case TELEPATHY_PRESENCE_STATE_AVAILABLE:
       
   443 		return "available";
       
   444 	case TELEPATHY_PRESENCE_STATE_BUSY:
       
   445 		return "dnd";
       
   446 	case TELEPATHY_PRESENCE_STATE_AWAY:
       
   447 		return "away";
       
   448 	case TELEPATHY_PRESENCE_STATE_EXT_AWAY:
       
   449 		return "xa";
       
   450 	case TELEPATHY_PRESENCE_STATE_HIDDEN:
       
   451 		return "hidden";
       
   452 	case TELEPATHY_PRESENCE_STATE_UNAVAILABLE:
       
   453 		return "offline";
       
   454 	default:
       
   455 		return NULL;
       
   456 	}
       
   457 
       
   458 	return NULL;
       
   459 }