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 <libtelepathy/tp-helpers.h>
  37 #include <libtelepathy/tp-conn.h>
  38
  39 #include "empathy-debug.h"
  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_DOMAIN "Utils"
  46
  47 static void regex_init (void);
  48
  49 gchar *
  50 empathy_substring (const gchar *str,
  51                   gint         start,
  52                   gint         end)
  53 {
  54         return g_strndup (str + start, end - start);
  55 }
  56
  57 /*
  58  * Regular Expression code to match urls.
  59  */
  60 #define USERCHARS "-A-Za-z0-9"
  61 #define PASSCHARS "-A-Za-z0-9,?;.:/!%$^*&~\"#'"
  62 #define HOSTCHARS "-A-Za-z0-9_"
  63 #define PATHCHARS "-A-Za-z0-9_$.+!*(),;:@&=?/~#%"
  64 #define SCHEME    "(news:|telnet:|nntp:|file:/|https?:|ftps?:|webcal:)"
  65 #define USER      "[" USERCHARS "]+(:["PASSCHARS "]+)?"
  66 #define URLPATH   "/[" PATHCHARS "]*[^]'.}>) \t\r\n,\\\"]"
  67
  68 static regex_t dingus[EMPATHY_REGEX_ALL];
  69
  70 static void
  71 regex_init (void)
  72 {
  73         static gboolean  inited = FALSE;
  74         const gchar     *expression;
  75         gint             i;
  76
  77         if (inited) {
  78                 return;
  79         }
  80
  81         for (i = 0; i < EMPATHY_REGEX_ALL; i++) {
  82                 switch (i) {
  83                 case EMPATHY_REGEX_AS_IS:
  84                         expression =
  85                                 SCHEME "//(" USER "@)?[" HOSTCHARS ".]+"
  86                                 "(:[0-9]+)?(" URLPATH ")?";
  87                         break;
  88                 case EMPATHY_REGEX_BROWSER:
  89                         expression =
  90                                 "(www|ftp)[" HOSTCHARS "]*\\.[" HOSTCHARS ".]+"
  91                                 "(:[0-9]+)?(" URLPATH ")?";
  92                         break;
  93                 case EMPATHY_REGEX_EMAIL:
  94                         expression =
  95                                 "(mailto:)?[a-z0-9][a-z0-9.-]*@[a-z0-9]"
  96                                 "[a-z0-9-]*(\\.[a-z0-9][a-z0-9-]*)+";
  97                         break;
  98                 case EMPATHY_REGEX_OTHER:
  99                         expression =
 100                                 "news:[-A-Z\\^_a-z{|}~!\"#$%&'()*+,./0-9;:=?`]+"
 101                                 "@[" HOSTCHARS ".]+(:[0-9]+)?";
 102                         break;
 103                 default:
 104                         /* Silence the compiler. */
 105                         expression = NULL;
 106                         continue;
 107                 }
 108
 109                 memset (&dingus[i], 0, sizeof (regex_t));
 110                 regcomp (&dingus[i], expression, REG_EXTENDED | REG_ICASE);
 111         }
 112
 113         inited = TRUE;
 114 }
 115
 116 gint
 117 empathy_regex_match (EmpathyRegExType  type,
 118                     const gchar     *msg,
 119                     GArray          *start,
 120                     GArray          *end)
 121 {
 122         regmatch_t matches[1];
 123         gint       ret = 0;
 124         gint       num_matches = 0;
 125         gint       offset = 0;
 126         gint       i;
 127
 128         g_return_val_if_fail (type >= 0 || type <= EMPATHY_REGEX_ALL, 0);
 129
 130         regex_init ();
 131
 132         while (!ret && type != EMPATHY_REGEX_ALL) {
 133                 ret = regexec (&dingus[type], msg + offset, 1, matches, 0);
 134                 if (ret == 0) {
 135                         gint s;
 136
 137                         num_matches++;
 138
 139                         s = matches[0].rm_so + offset;
 140                         offset = matches[0].rm_eo + offset;
 141
 142                         g_array_append_val (start, s);
 143                         g_array_append_val (end, offset);
 144                 }
 145         }
 146
 147         if (type != EMPATHY_REGEX_ALL) {
 148                 empathy_debug (DEBUG_DOMAIN,
 149                               "Found %d matches for regex type:%d",
 150                               num_matches, type);
 151                 return num_matches;
 152         }
 153
 154         /* If EMPATHY_REGEX_ALL then we run ALL regex's on the string. */
 155         for (i = 0; i < EMPATHY_REGEX_ALL; i++, ret = 0) {
 156                 while (!ret) {
 157                         ret = regexec (&dingus[i], msg + offset, 1, matches, 0);
 158                         if (ret == 0) {
 159                                 gint s;
 160
 161                                 num_matches++;
 162
 163                                 s = matches[0].rm_so + offset;
 164                                 offset = matches[0].rm_eo + offset;
 165
 166                                 g_array_append_val (start, s);
 167                                 g_array_append_val (end, offset);
 168                         }
 169                 }
 170         }
 171
 172         empathy_debug (DEBUG_DOMAIN,
 173                       "Found %d matches for ALL regex types",
 174                       num_matches);
 175
 176         return num_matches;
 177 }
 178
 179 gint
 180 empathy_strcasecmp (const gchar *s1,
 181                    const gchar *s2)
 182 {
 183         return empathy_strncasecmp (s1, s2, -1);
 184 }
 185
 186 gint
 187 empathy_strncasecmp (const gchar *s1,
 188                     const gchar *s2,
 189                     gsize        n)
 190 {
 191         gchar *u1, *u2;
 192         gint   ret_val;
 193
 194         u1 = g_utf8_casefold (s1, n);
 195         u2 = g_utf8_casefold (s2, n);
 196
 197         ret_val = g_utf8_collate (u1, u2);
 198         g_free (u1);
 199         g_free (u2);
 200
 201         return ret_val;
 202 }
 203
 204 gboolean
 205 empathy_xml_validate (xmlDoc      *doc,
 206                      const gchar *dtd_filename)
 207 {
 208         gchar        *path, *escaped;
 209         xmlValidCtxt  cvp;
 210         xmlDtd       *dtd;
 211         gboolean      ret;
 212
 213         path = g_build_filename (g_getenv ("EMPATHY_SRCDIR"), "libempathy",
 214                                  dtd_filename, NULL);
 215         if (!g_file_test (path, G_FILE_TEST_EXISTS)) {
 216                 g_free (path);
 217                 path = g_build_filename (DATADIR, "empathy", dtd_filename, NULL);
 218         }
 219         empathy_debug (DEBUG_DOMAIN, "Loading dtd file %s", path);
 220
 221         /* The list of valid chars is taken from libxml. */
 222         escaped = xmlURIEscapeStr (path, ":@&=+$,/?;");
 223         g_free (path);
 224
 225         memset (&cvp, 0, sizeof (cvp));
 226         dtd = xmlParseDTD (NULL, escaped);
 227         ret = xmlValidateDtd (&cvp, doc, dtd);
 228
 229         xmlFree (escaped);
 230         xmlFreeDtd (dtd);
 231
 232         return ret;
 233 }
 234
 235 xmlNodePtr
 236 empathy_xml_node_get_child (xmlNodePtr   node,
 237                            const gchar *child_name)
 238 {
 239         xmlNodePtr l;
 240
 241         g_return_val_if_fail (node != NULL, NULL);
 242         g_return_val_if_fail (child_name != NULL, NULL);
 243
 244         for (l = node->children; l; l = l->next) {
 245                 if (l->name && strcmp (l->name, child_name) == 0) {
 246                         return l;
 247                 }
 248         }
 249
 250         return NULL;
 251 }
 252
 253 xmlChar *
 254 empathy_xml_node_get_child_content (xmlNodePtr   node,
 255                                    const gchar *child_name)
 256 {
 257         xmlNodePtr l;
 258
 259         g_return_val_if_fail (node != NULL, NULL);
 260         g_return_val_if_fail (child_name != NULL, NULL);
 261
 262         l = empathy_xml_node_get_child (node, child_name);
 263         if (l) {
 264                 return xmlNodeGetContent (l);
 265         }
 266
 267         return NULL;
 268 }
 269
 270 xmlNodePtr
 271 empathy_xml_node_find_child_prop_value (xmlNodePtr   node,
 272                                        const gchar *prop_name,
 273                                        const gchar *prop_value)
 274 {
 275         xmlNodePtr l;
 276         xmlNodePtr found = NULL;
 277
 278         g_return_val_if_fail (node != NULL, NULL);
 279         g_return_val_if_fail (prop_name != NULL, NULL);
 280         g_return_val_if_fail (prop_value != NULL, NULL);
 281
 282         for (l = node->children; l && !found; l = l->next) {
 283                 xmlChar *prop;
 284
 285                 if (!xmlHasProp (l, prop_name)) {
 286                         continue;
 287                 }
 288
 289                 prop = xmlGetProp (l, prop_name);
 290                 if (prop && strcmp (prop, prop_value) == 0) {
 291                         found = l;
 292                 }
 293
 294                 xmlFree (prop);
 295         }
 296
 297         return found;
 298 }
 299
 300 guint
 301 empathy_account_hash (gconstpointer key)
 302 {
 303         g_return_val_if_fail (MC_IS_ACCOUNT (key), 0);
 304
 305         return g_str_hash (mc_account_get_unique_name (MC_ACCOUNT (key)));
 306 }
 307
 308 gboolean
 309 empathy_account_equal (gconstpointer a,
 310                        gconstpointer b)
 311 {
 312         const gchar *name_a;
 313         const gchar *name_b;
 314
 315         g_return_val_if_fail (MC_IS_ACCOUNT (a), FALSE);
 316         g_return_val_if_fail (MC_IS_ACCOUNT (b), FALSE);
 317
 318         name_a = mc_account_get_unique_name (MC_ACCOUNT (a));
 319         name_b = mc_account_get_unique_name (MC_ACCOUNT (b));
 320
 321         return g_str_equal (name_a, name_b);
 322 }
 323
 324 MissionControl *
 325 empathy_mission_control_new (void)
 326 {
 327         static MissionControl *mc = NULL;
 328
 329         if (!mc) {
 330                 mc = mission_control_new (tp_get_bus ());
 331                 g_object_add_weak_pointer (G_OBJECT (mc), (gpointer) &mc);
 332         } else {
 333                 g_object_ref (mc);
 334         }
 335
 336         return mc;
 337 }
 338
 339 gchar *
 340 empathy_inspect_channel (McAccount *account,
 341                          TpChan    *tp_chan)
 342 {
 343         g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
 344         g_return_val_if_fail (TELEPATHY_IS_CHAN (tp_chan), NULL);
 345
 346         return empathy_inspect_handle (account,
 347                                        tp_chan->handle,
 348                                        tp_chan->handle_type);
 349 }
 350
 351 gchar *
 352 empathy_inspect_handle (McAccount *account,
 353                         guint      handle,
 354                         guint      handle_type)
 355 {
 356         MissionControl  *mc;
 357         TpConn          *tp_conn;
 358         GArray          *handles;
 359         gchar          **names;
 360         gchar           *name;
 361         GError          *error = NULL;
 362
 363         g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
 364         g_return_val_if_fail (handle != 0, NULL);
 365         g_return_val_if_fail (handle_type != 0, NULL);
 366
 367         mc = empathy_mission_control_new ();
 368         tp_conn = mission_control_get_connection (mc, account, NULL);
 369         g_object_unref (mc);
 370
 371         if (!tp_conn) {
 372                 return NULL;
 373         }
 374
 375         /* Get the handle's name */
 376         handles = g_array_new (FALSE, FALSE, sizeof (guint));
 377         g_array_append_val (handles, handle);
 378         if (!tp_conn_inspect_handles (DBUS_G_PROXY (tp_conn),
 379                                       handle_type,
 380                                       handles,
 381                                       &names,
 382                                       &error)) {
 383                 empathy_debug (DEBUG_DOMAIN,
 384                               "Couldn't get id: %s",
 385                               error ? error->message : "No error given");
 386
 387                 g_clear_error (&error);
 388                 g_array_free (handles, TRUE);
 389                 g_object_unref (tp_conn);
 390
 391                 return NULL;
 392         }
 393
 394         g_array_free (handles, TRUE);
 395         name = *names;
 396         g_free (names);
 397         g_object_unref (tp_conn);
 398
 399         return name;
 400 }
 401
 402 void
 403 empathy_call_with_contact (EmpathyContact *contact)
 404 {
 405 #ifdef HAVE_VOIP
 406         MissionControl        *mc;
 407         McAccount             *account;
 408         TpConn                *tp_conn;
 409         gchar                 *object_path;
 410         const gchar           *bus_name;
 411         TpChan                *new_chan;
 412         EmpathyContactFactory *factory;
 413         EmpathyTpGroup        *group;
 414         EmpathyContact        *self_contact;
 415         GError                *error = NULL;
 416
 417         g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 418
 419         /* StreamedMedia channels must have handle=0 and handle_type=none.
 420          * To call a contact we have to add him in the group interface of the
 421          * channel. MissionControl will detect the channel creation and
 422          * dispatch it to the VoIP chandler automatically. */
 423
 424         mc = empathy_mission_control_new ();
 425         account = empathy_contact_get_account (contact);
 426         tp_conn = mission_control_get_connection (mc, account, NULL);
 427         /* FIXME: Should be async */
 428         if (!tp_conn_request_channel (DBUS_G_PROXY (tp_conn),
 429                                       TP_IFACE_CHANNEL_TYPE_STREAMED_MEDIA,
 430                                       TP_HANDLE_TYPE_NONE,
 431                                       0,
 432                                       FALSE,
 433                                       &object_path,
 434                                       &error)) {
 435                 empathy_debug (DEBUG_DOMAIN,
 436                               "Couldn't request channel: %s",
 437                               error ? error->message : "No error given");
 438                 g_clear_error (&error);
 439                 g_object_unref (mc);
 440                 g_object_unref (tp_conn);
 441                 return;
 442         }
 443
 444         bus_name = dbus_g_proxy_get_bus_name (DBUS_G_PROXY (tp_conn));
 445         new_chan = tp_chan_new (tp_get_bus (),
 446                                 bus_name,
 447                                 object_path,
 448                                 TP_IFACE_CHANNEL_TYPE_STREAMED_MEDIA,
 449                                 TP_HANDLE_TYPE_NONE,
 450                                 0);
 451
 452         group = empathy_tp_group_new (account, new_chan);
 453         factory = empathy_contact_factory_new ();
 454         self_contact = empathy_contact_factory_get_user (factory, account);
 455         empathy_tp_group_add_member (group, contact, "");
 456         empathy_tp_group_add_member (group, self_contact, "");
 457
 458         g_object_unref (factory);
 459         g_object_unref (self_contact);
 460         g_object_unref (group);
 461         g_object_unref (mc);
 462         g_object_unref (tp_conn);
 463         g_object_unref (new_chan);
 464         g_free (object_path);
 465 #endif
 466 }
 467
 468 #ifdef HAVE_VOIP
 469 static void
 470 got_handle_cb (EmpathyContact        *contact,
 471                GParamSpec            *property,
 472                EmpathyContactFactory *factory)
 473 {
 474         g_signal_handlers_disconnect_by_func (contact,
 475                                               got_handle_cb,
 476                                               factory);
 477
 478         empathy_call_with_contact (contact);
 479         g_object_unref (factory);
 480         g_object_unref (contact);
 481 }
 482 #endif
 483
 484 void
 485 empathy_call_with_contact_id (McAccount *account, const gchar *contact_id)
 486 {
 487 #ifdef HAVE_VOIP
 488         EmpathyContactFactory *factory;
 489         EmpathyContact        *contact;
 490
 491         factory = empathy_contact_factory_new ();
 492         contact = empathy_contact_factory_get_from_id (factory, account, contact_id);
 493
 494         if (empathy_contact_get_handle (contact) != 0) {
 495                 empathy_call_with_contact (contact);
 496                 g_object_unref (contact);
 497                 g_object_unref (factory);
 498         } else {
 499                 g_signal_connect (contact, "notify::handle",
 500                                   G_CALLBACK (got_handle_cb),
 501                                   factory);
 502         }
 503 #endif
 504 }
 505
 506 void
 507 empathy_chat_with_contact (EmpathyContact  *contact)
 508 {
 509         MissionControl *mc;
 510
 511         mc = empathy_mission_control_new ();
 512         mission_control_request_channel (mc,
 513                                          empathy_contact_get_account (contact),
 514                                          TP_IFACE_CHANNEL_TYPE_TEXT,
 515                                          empathy_contact_get_handle (contact),
 516                                          TP_HANDLE_TYPE_CONTACT,
 517                                          NULL, NULL);
 518         g_object_unref (mc);
 519 }
 520
 521 void
 522 empathy_chat_with_contact_id (McAccount *account, const gchar *contact_id)
 523 {
 524         MissionControl *mc;
 525
 526         mc = empathy_mission_control_new ();
 527         mission_control_request_channel_with_string_handle (mc,
 528                                                             account,
 529                                                             TP_IFACE_CHANNEL_TYPE_TEXT,
 530                                                             contact_id,
 531                                                             TP_HANDLE_TYPE_CONTACT,
 532                                                             NULL, NULL);
 533         g_object_unref (mc);
 534 }
 535
 536 const gchar *
 537 empathy_presence_get_default_message (McPresence presence)
 538 {
 539         switch (presence) {
 540         case MC_PRESENCE_AVAILABLE:
 541                 return _("Available");
 542         case MC_PRESENCE_DO_NOT_DISTURB:
 543                 return _("Busy");
 544         case MC_PRESENCE_AWAY:
 545         case MC_PRESENCE_EXTENDED_AWAY:
 546                 return _("Away");
 547         case MC_PRESENCE_HIDDEN:
 548                 return _("Hidden");
 549         case MC_PRESENCE_OFFLINE:
 550         case MC_PRESENCE_UNSET:
 551                 return _("Offline");
 552         default:
 553                 g_assert_not_reached ();
 554         }
 555
 556         return NULL;
 557 }
 558
 559 const gchar *
 560 empathy_presence_to_str (McPresence presence)
 561 {
 562         switch (presence) {
 563         case MC_PRESENCE_AVAILABLE:
 564                 return "available";
 565         case MC_PRESENCE_DO_NOT_DISTURB:
 566                 return "busy";
 567         case MC_PRESENCE_AWAY:
 568                 return "away";
 569         case MC_PRESENCE_EXTENDED_AWAY:
 570                 return "ext_away";
 571         case MC_PRESENCE_HIDDEN:
 572                 return "hidden";
 573         case MC_PRESENCE_OFFLINE:
 574                 return "offline";
 575         case MC_PRESENCE_UNSET:
 576                 return "unset";
 577         default:
 578                 g_assert_not_reached ();
 579         }
 580
 581         return NULL;
 582 }
 583
 584 McPresence
 585 empathy_presence_from_str (const gchar *str)
 586 {
 587         if (strcmp (str, "available") == 0) {
 588                 return MC_PRESENCE_AVAILABLE;
 589         } else if ((strcmp (str, "dnd") == 0) || (strcmp (str, "busy") == 0)) {
 590                 return MC_PRESENCE_DO_NOT_DISTURB;
 591         } else if ((strcmp (str, "away") == 0) || (strcmp (str, "brb") == 0)) {
 592                 return MC_PRESENCE_AWAY;
 593         } else if ((strcmp (str, "xa") == 0) || (strcmp (str, "ext_away") == 0)) {
 594                 return MC_PRESENCE_EXTENDED_AWAY;
 595         } else if (strcmp (str, "hidden") == 0) {
 596                 return MC_PRESENCE_HIDDEN;
 597         } else if (strcmp (str, "offline") == 0) {
 598                 return MC_PRESENCE_OFFLINE;
 599         } else if (strcmp (str, "unset") == 0) {
 600                 return MC_PRESENCE_UNSET;
 601         }
 602
 603         return MC_PRESENCE_AVAILABLE;
 604 }
 605