libempathy/empathy-utils.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2003-2007 Imendio AB
   4  * Copyright (C) 2007-2008 Collabora Ltd.
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public
  17  * License along with this program; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  *
  21  * Authors: Richard Hult <richard@imendio.com>
  22  *          Martyn Russell <martyn@imendio.com>
  23  *          Xavier Claessens <xclaesse@gmail.com>
  24  */
  25
  26 #include "config.h"
  27
  28 #include <string.h>
  29 #include <time.h>
  30 #include <sys/types.h>
  31 #include <regex.h>
  32
  33 #include <glib/gi18n.h>
  34
  35 #include <libxml/uri.h>
  36 #include <telepathy-glib/connection.h>
  37 #include <telepathy-glib/channel.h>
  38 #include <telepathy-glib/dbus.h>
  39
  40 #include "empathy-utils.h"
  41 #include "empathy-contact-factory.h"
  42 #include "empathy-contact-manager.h"
  43 #include "empathy-tp-group.h"
  44
  45 #define DEBUG_FLAG EMPATHY_DEBUG_OTHER
  46 #include "empathy-debug.h"
  47
  48 static void regex_init (void);
  49
  50 gchar *
  51 empathy_substring (const gchar *str,
  52                   gint         start,
  53                   gint         end)
  54 {
  55         return g_strndup (str + start, end - start);
  56 }
  57
  58 /*
  59  * Regular Expression code to match urls.
  60  */
  61 #define APTCHARS  "-A-Za-z0-9,-."
  62 #define USERCHARS "-A-Za-z0-9"
  63 #define PASSCHARS "-A-Za-z0-9,?;.:/!%$^*&~\"#'"
  64 #define HOSTCHARS "-A-Za-z0-9_"
  65 #define PATHCHARS "-A-Za-z0-9_$.+!*(),;:@&=?/~#%"
  66 #define SCHEME    "(news:|telnet:|nntp:|file:/|https?:|ftps?:|webcal:)"
  67 #define USER      "[" USERCHARS "]+(:["PASSCHARS "]+)?"
  68 #define URLPATH   "/[" PATHCHARS "]*[^]'.}>) \t\r\n,\\\"]"
  69
  70 static regex_t dingus[EMPATHY_REGEX_ALL];
  71
  72 static void
  73 regex_init (void)
  74 {
  75         static gboolean  inited = FALSE;
  76         const gchar     *expression;
  77         gint             i;
  78
  79         if (inited) {
  80                 return;
  81         }
  82
  83         for (i = 0; i < EMPATHY_REGEX_ALL; i++) {
  84                 switch (i) {
  85                 case EMPATHY_REGEX_AS_IS:
  86                         expression =
  87                                 SCHEME "//(" USER "@)?[" HOSTCHARS ".]+"
  88                                 "(:[0-9]+)?(" URLPATH ")?";
  89                         break;
  90                 case EMPATHY_REGEX_BROWSER:
  91                         expression =
  92                                 "(www|ftp)[" HOSTCHARS "]*\\.[" HOSTCHARS ".]+"
  93                                 "(:[0-9]+)?(" URLPATH ")?";
  94                         break;
  95                 case EMPATHY_REGEX_APT:
  96                         expression =
  97                                 "apt://[" APTCHARS "]*";
  98                         break;
  99                 case EMPATHY_REGEX_EMAIL:
 100                         expression =
 101                                 "(mailto:)?[a-z0-9][a-z0-9.-]*@[a-z0-9]"
 102                                 "[a-z0-9-]*(\\.[a-z0-9][a-z0-9-]*)+";
 103                         break;
 104                 case EMPATHY_REGEX_OTHER:
 105                         expression =
 106                                 "news:[-A-Z\\^_a-z{|}~!\"#$%&'()*+,./0-9;:=?`]+"
 107                                 "@[" HOSTCHARS ".]+(:[0-9]+)?";
 108                         break;
 109                 default:
 110                         /* Silence the compiler. */
 111                         expression = NULL;
 112                         continue;
 113                 }
 114
 115                 memset (&dingus[i], 0, sizeof (regex_t));
 116                 regcomp (&dingus[i], expression, REG_EXTENDED | REG_ICASE);
 117         }
 118
 119         inited = TRUE;
 120 }
 121
 122 gint
 123 empathy_regex_match (EmpathyRegExType  type,
 124                     const gchar     *msg,
 125                     GArray          *start,
 126                     GArray          *end)
 127 {
 128         regmatch_t matches[1];
 129         gint       ret = 0;
 130         gint       num_matches = 0;
 131         gint       offset = 0;
 132         gint       i;
 133
 134         g_return_val_if_fail (type >= 0 || type <= EMPATHY_REGEX_ALL, 0);
 135
 136         regex_init ();
 137
 138         while (!ret && type != EMPATHY_REGEX_ALL) {
 139                 ret = regexec (&dingus[type], msg + offset, 1, matches, 0);
 140                 if (ret == 0) {
 141                         gint s;
 142
 143                         num_matches++;
 144
 145                         s = matches[0].rm_so + offset;
 146                         offset = matches[0].rm_eo + offset;
 147
 148                         g_array_append_val (start, s);
 149                         g_array_append_val (end, offset);
 150                 }
 151         }
 152
 153         if (type != EMPATHY_REGEX_ALL) {
 154                 DEBUG ("Found %d matches for regex type:%d", num_matches, type);
 155                 return num_matches;
 156         }
 157
 158         /* If EMPATHY_REGEX_ALL then we run ALL regex's on the string. */
 159         for (i = 0; i < EMPATHY_REGEX_ALL; i++, ret = 0) {
 160                 while (!ret) {
 161                         ret = regexec (&dingus[i], msg + offset, 1, matches, 0);
 162                         if (ret == 0) {
 163                                 gint s;
 164
 165                                 num_matches++;
 166
 167                                 s = matches[0].rm_so + offset;
 168                                 offset = matches[0].rm_eo + offset;
 169
 170                                 g_array_append_val (start, s);
 171                                 g_array_append_val (end, offset);
 172                         }
 173                 }
 174         }
 175
 176         DEBUG ("Found %d matches for ALL regex types", num_matches);
 177
 178         return num_matches;
 179 }
 180
 181 gint
 182 empathy_strcasecmp (const gchar *s1,
 183                    const gchar *s2)
 184 {
 185         return empathy_strncasecmp (s1, s2, -1);
 186 }
 187
 188 gint
 189 empathy_strncasecmp (const gchar *s1,
 190                     const gchar *s2,
 191                     gsize        n)
 192 {
 193         gchar *u1, *u2;
 194         gint   ret_val;
 195
 196         u1 = g_utf8_casefold (s1, n);
 197         u2 = g_utf8_casefold (s2, n);
 198
 199         ret_val = g_utf8_collate (u1, u2);
 200         g_free (u1);
 201         g_free (u2);
 202
 203         return ret_val;
 204 }
 205
 206 gboolean
 207 empathy_xml_validate (xmlDoc      *doc,
 208                      const gchar *dtd_filename)
 209 {
 210         gchar        *path, *escaped;
 211         xmlValidCtxt  cvp;
 212         xmlDtd       *dtd;
 213         gboolean      ret;
 214
 215         path = g_build_filename (g_getenv ("EMPATHY_SRCDIR"), "libempathy",
 216                                  dtd_filename, NULL);
 217         if (!g_file_test (path, G_FILE_TEST_EXISTS)) {
 218                 g_free (path);
 219                 path = g_build_filename (DATADIR, "empathy", dtd_filename, NULL);
 220         }
 221         DEBUG ("Loading dtd file %s", path);
 222
 223         /* The list of valid chars is taken from libxml. */
 224         escaped = xmlURIEscapeStr (path, ":@&=+$,/?;");
 225         g_free (path);
 226
 227         memset (&cvp, 0, sizeof (cvp));
 228         dtd = xmlParseDTD (NULL, escaped);
 229         ret = xmlValidateDtd (&cvp, doc, dtd);
 230
 231         xmlFree (escaped);
 232         xmlFreeDtd (dtd);
 233
 234         return ret;
 235 }
 236
 237 xmlNodePtr
 238 empathy_xml_node_get_child (xmlNodePtr   node,
 239                            const gchar *child_name)
 240 {
 241         xmlNodePtr l;
 242
 243         g_return_val_if_fail (node != NULL, NULL);
 244         g_return_val_if_fail (child_name != NULL, NULL);
 245
 246         for (l = node->children; l; l = l->next) {
 247                 if (l->name && strcmp (l->name, child_name) == 0) {
 248                         return l;
 249                 }
 250         }
 251
 252         return NULL;
 253 }
 254
 255 xmlChar *
 256 empathy_xml_node_get_child_content (xmlNodePtr   node,
 257                                    const gchar *child_name)
 258 {
 259         xmlNodePtr l;
 260
 261         g_return_val_if_fail (node != NULL, NULL);
 262         g_return_val_if_fail (child_name != NULL, NULL);
 263
 264         l = empathy_xml_node_get_child (node, child_name);
 265         if (l) {
 266                 return xmlNodeGetContent (l);
 267         }
 268
 269         return NULL;
 270 }
 271
 272 xmlNodePtr
 273 empathy_xml_node_find_child_prop_value (xmlNodePtr   node,
 274                                        const gchar *prop_name,
 275                                        const gchar *prop_value)
 276 {
 277         xmlNodePtr l;
 278         xmlNodePtr found = NULL;
 279
 280         g_return_val_if_fail (node != NULL, NULL);
 281         g_return_val_if_fail (prop_name != NULL, NULL);
 282         g_return_val_if_fail (prop_value != NULL, NULL);
 283
 284         for (l = node->children; l && !found; l = l->next) {
 285                 xmlChar *prop;
 286
 287                 if (!xmlHasProp (l, prop_name)) {
 288                         continue;
 289                 }
 290
 291                 prop = xmlGetProp (l, prop_name);
 292                 if (prop && strcmp (prop, prop_value) == 0) {
 293                         found = l;
 294                 }
 295
 296                 xmlFree (prop);
 297         }
 298
 299         return found;
 300 }
 301
 302 guint
 303 empathy_account_hash (gconstpointer key)
 304 {
 305         g_return_val_if_fail (MC_IS_ACCOUNT (key), 0);
 306
 307         return g_str_hash (mc_account_get_unique_name (MC_ACCOUNT (key)));
 308 }
 309
 310 gboolean
 311 empathy_account_equal (gconstpointer a,
 312                        gconstpointer b)
 313 {
 314         const gchar *name_a;
 315         const gchar *name_b;
 316
 317         g_return_val_if_fail (MC_IS_ACCOUNT (a), FALSE);
 318         g_return_val_if_fail (MC_IS_ACCOUNT (b), FALSE);
 319
 320         name_a = mc_account_get_unique_name (MC_ACCOUNT (a));
 321         name_b = mc_account_get_unique_name (MC_ACCOUNT (b));
 322
 323         return g_str_equal (name_a, name_b);
 324 }
 325
 326 MissionControl *
 327 empathy_mission_control_new (void)
 328 {
 329         static MissionControl *mc = NULL;
 330
 331         if (!mc) {
 332                 mc = mission_control_new (tp_get_bus ());
 333                 g_object_add_weak_pointer (G_OBJECT (mc), (gpointer) &mc);
 334         } else {
 335                 g_object_ref (mc);
 336         }
 337
 338         return mc;
 339 }
 340
 341 const gchar *
 342 empathy_presence_get_default_message (McPresence presence)
 343 {
 344         switch (presence) {
 345         case MC_PRESENCE_AVAILABLE:
 346                 return _("Available");
 347         case MC_PRESENCE_DO_NOT_DISTURB:
 348                 return _("Busy");
 349         case MC_PRESENCE_AWAY:
 350         case MC_PRESENCE_EXTENDED_AWAY:
 351                 return _("Away");
 352         case MC_PRESENCE_HIDDEN:
 353                 return _("Hidden");
 354         case MC_PRESENCE_OFFLINE:
 355         case MC_PRESENCE_UNSET:
 356                 return _("Offline");
 357         default:
 358                 g_assert_not_reached ();
 359         }
 360
 361         return NULL;
 362 }
 363
 364 const gchar *
 365 empathy_presence_to_str (McPresence presence)
 366 {
 367         switch (presence) {
 368         case MC_PRESENCE_AVAILABLE:
 369                 return "available";
 370         case MC_PRESENCE_DO_NOT_DISTURB:
 371                 return "busy";
 372         case MC_PRESENCE_AWAY:
 373                 return "away";
 374         case MC_PRESENCE_EXTENDED_AWAY:
 375                 return "ext_away";
 376         case MC_PRESENCE_HIDDEN:
 377                 return "hidden";
 378         case MC_PRESENCE_OFFLINE:
 379                 return "offline";
 380         case MC_PRESENCE_UNSET:
 381                 return "unset";
 382         default:
 383                 g_assert_not_reached ();
 384         }
 385
 386         return NULL;
 387 }
 388
 389 McPresence
 390 empathy_presence_from_str (const gchar *str)
 391 {
 392         if (strcmp (str, "available") == 0) {
 393                 return MC_PRESENCE_AVAILABLE;
 394         } else if ((strcmp (str, "dnd") == 0) || (strcmp (str, "busy") == 0)) {
 395                 return MC_PRESENCE_DO_NOT_DISTURB;
 396         } else if ((strcmp (str, "away") == 0) || (strcmp (str, "brb") == 0)) {
 397                 return MC_PRESENCE_AWAY;
 398         } else if ((strcmp (str, "xa") == 0) || (strcmp (str, "ext_away") == 0)) {
 399                 return MC_PRESENCE_EXTENDED_AWAY;
 400         } else if (strcmp (str, "hidden") == 0) {
 401                 return MC_PRESENCE_HIDDEN;
 402         } else if (strcmp (str, "offline") == 0) {
 403                 return MC_PRESENCE_OFFLINE;
 404         } else if (strcmp (str, "unset") == 0) {
 405                 return MC_PRESENCE_UNSET;
 406         }
 407
 408         return MC_PRESENCE_AVAILABLE;
 409 }
 410
 411 gchar *
 412 empathy_file_lookup (const gchar *filename, const gchar *subdir)
 413 {
 414         gchar *path;
 415
 416         if (!subdir) {
 417                 subdir = ".";
 418         }
 419
 420         path = g_build_filename (g_getenv ("EMPATHY_SRCDIR"), subdir, filename, NULL);
 421         if (!g_file_test (path, G_FILE_TEST_EXISTS)) {
 422                 g_free (path);
 423                 path = g_build_filename (DATADIR, "empathy", filename, NULL);
 424         }
 425
 426         return path;
 427 }
 428
 429 typedef struct {
 430         EmpathyRunUntilReadyFunc  func;
 431         gpointer                  user_data;
 432         GObject                  *object;
 433         GMainLoop                *loop;
 434 } RunUntilReadyData;
 435
 436 static void
 437 run_until_ready_cb (RunUntilReadyData *data)
 438 {
 439         if (!data->func || data->func (data->object, data->user_data)) {
 440                 DEBUG ("Object %p is ready", data->object);
 441                 g_main_loop_quit (data->loop);
 442         }
 443 }
 444
 445 static gboolean
 446 object_is_ready (GObject *object,
 447                  gpointer user_data)
 448 {
 449         gboolean ready;
 450
 451         g_object_get (object, "ready", &ready, NULL);
 452
 453         return ready;
 454 }
 455
 456 void
 457 empathy_run_until_ready_full (gpointer                  object,
 458                               const gchar              *signal,
 459                               EmpathyRunUntilReadyFunc  func,
 460                               gpointer                  user_data,
 461                               GMainLoop               **loop)
 462 {
 463         RunUntilReadyData  data;
 464         gulong             signal_id;
 465
 466         g_return_if_fail (G_IS_OBJECT (object));
 467         g_return_if_fail (signal != NULL);
 468
 469         if (func && func (object, user_data)) {
 470                 return;
 471         }
 472
 473         DEBUG ("Starting run until ready for object %p", object);
 474
 475         data.func = func;
 476         data.user_data = user_data;
 477         data.object = object;
 478         data.loop = g_main_loop_new (NULL, FALSE);
 479
 480         signal_id = g_signal_connect_swapped (object, signal,
 481                                               G_CALLBACK (run_until_ready_cb),
 482                                               &data);
 483         if (loop != NULL) {
 484                 *loop = data.loop;
 485         }
 486
 487         g_main_loop_run (data.loop);
 488
 489         if (loop != NULL) {
 490                 *loop = NULL;
 491         }
 492
 493         g_signal_handler_disconnect (object, signal_id);
 494         g_main_loop_unref (data.loop);
 495 }
 496
 497 void
 498 empathy_run_until_ready (gpointer object)
 499 {
 500         empathy_run_until_ready_full (object, "notify::ready", object_is_ready,
 501                                       NULL, NULL);
 502 }
 503
 504 McAccount *
 505 empathy_channel_get_account (TpChannel *channel)
 506 {
 507         TpConnection   *connection;
 508         McAccount      *account;
 509         MissionControl *mc;
 510
 511         g_object_get (channel, "connection", &connection, NULL);
 512         mc = empathy_mission_control_new ();
 513         account = mission_control_get_account_for_tpconnection (mc, connection, NULL);
 514         g_object_unref (connection);
 515         g_object_unref (mc);
 516
 517         return account;
 518 }
 519
 520 typedef void (*AccountStatusChangedFunc) (MissionControl           *mc,
 521                                           TpConnectionStatus        status,
 522                                           McPresence                presence,
 523                                           TpConnectionStatusReason  reason,
 524                                           const gchar              *unique_name,
 525                                           gpointer                  user_data);
 526
 527 typedef struct {
 528         AccountStatusChangedFunc handler;
 529         gpointer                 user_data;
 530         GClosureNotify           free_func;
 531         MissionControl          *mc;
 532 } AccountStatusChangedData;
 533
 534 typedef struct {
 535         TpConnectionStatus        status;
 536         McPresence                presence;
 537         TpConnectionStatusReason  reason;
 538         gchar                    *unique_name;
 539         AccountStatusChangedData *data;
 540 } InvocationData;
 541
 542 static void
 543 account_status_changed_data_free (gpointer ptr,
 544                                   GClosure *closure)
 545 {
 546         AccountStatusChangedData *data = ptr;
 547
 548         if (data->free_func) {
 549                 data->free_func (data->user_data, closure);
 550         }
 551         g_object_unref (data->mc);
 552         g_slice_free (AccountStatusChangedData, data);
 553 }
 554
 555 static gboolean
 556 account_status_changed_invoke_callback (gpointer data)
 557 {
 558         InvocationData *invocation_data = data;
 559
 560         invocation_data->data->handler (invocation_data->data->mc,
 561                                         invocation_data->status,
 562                                         invocation_data->presence,
 563                                         invocation_data->reason,
 564                                         invocation_data->unique_name,
 565                                         invocation_data->data->user_data);
 566
 567         g_free (invocation_data->unique_name);
 568         g_slice_free (InvocationData, invocation_data);
 569
 570         return FALSE;
 571 }
 572
 573 static void
 574 account_status_changed_cb (MissionControl           *mc,
 575                            TpConnectionStatus        status,
 576                            McPresence                presence,
 577                            TpConnectionStatusReason  reason,
 578                            const gchar              *unique_name,
 579                            AccountStatusChangedData *data)
 580 {
 581         InvocationData *invocation_data;
 582
 583         invocation_data = g_slice_new (InvocationData);
 584         invocation_data->status = status;
 585         invocation_data->presence = presence;
 586         invocation_data->reason = reason;
 587         invocation_data->unique_name = g_strdup (unique_name);
 588         invocation_data->data = data;
 589
 590         g_idle_add_full (G_PRIORITY_HIGH,
 591                          account_status_changed_invoke_callback,
 592                          invocation_data, NULL);
 593 }
 594
 595 gpointer
 596 empathy_connect_to_account_status_changed (MissionControl *mc,
 597                                            GCallback       handler,
 598                                            gpointer        user_data,
 599                                            GClosureNotify  free_func)
 600 {
 601         AccountStatusChangedData *data;
 602
 603         g_return_val_if_fail (IS_MISSIONCONTROL (mc), NULL);
 604         g_return_val_if_fail (handler != NULL, NULL);
 605
 606         data = g_slice_new (AccountStatusChangedData);
 607         data->handler = (AccountStatusChangedFunc) handler;
 608         data->user_data = user_data;
 609         data->free_func = free_func;
 610         data->mc = g_object_ref (mc);
 611
 612         dbus_g_proxy_connect_signal (DBUS_G_PROXY (mc), "AccountStatusChanged",
 613                                      G_CALLBACK (account_status_changed_cb),
 614                                      data, account_status_changed_data_free);
 615
 616         return data;
 617 }
 618
 619 void
 620 empathy_disconnect_account_status_changed (gpointer token)
 621 {
 622         AccountStatusChangedData *data = token;
 623
 624         dbus_g_proxy_disconnect_signal (DBUS_G_PROXY (data->mc),
 625                                         "AccountStatusChanged",
 626                                         G_CALLBACK (account_status_changed_cb),
 627                                         data);
 628 }
 629
 630 guint
 631 empathy_proxy_hash (gconstpointer key)
 632 {
 633         TpProxy *proxy = TP_PROXY (key);
 634
 635         g_return_val_if_fail (TP_IS_PROXY (proxy), 0);
 636
 637         return g_str_hash (proxy->object_path) +
 638                g_str_hash (proxy->bus_name);
 639 }
 640
 641 gboolean
 642 empathy_proxy_equal (gconstpointer a,
 643                      gconstpointer b)
 644 {
 645         TpProxy *proxy_a = TP_PROXY (a);
 646         TpProxy *proxy_b = TP_PROXY (b);
 647
 648         g_return_val_if_fail (TP_IS_PROXY (proxy_a), FALSE);
 649         g_return_val_if_fail (TP_IS_PROXY (proxy_b), FALSE);
 650
 651         return g_str_equal (proxy_a->object_path, proxy_b->object_path) &&
 652                g_str_equal (proxy_a->bus_name, proxy_b->bus_name);
 653 }
 654