Util/ImBuddy.cs

   1 //
   2 // ImBuddy.cs
   3 //
   4 // Copyright (C) 2004 Matthew Jones <mattharrison sbcglobal net>
   5 //
   6
   7 //
   8 // Permission is hereby granted, free of charge, to any person obtaining a copy
   9 // of this software and associated documentation files (the "Software"), to deal
  10 // in the Software without restriction, including without limitation the rights
  11 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12 // copies of the Software, and to permit persons to whom the Software is
  13 // furnished to do so, subject to the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be included in all
  16 // copies or substantial portions of the Software.
  17 //
  18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24 // SOFTWARE.
  25 //
  26
  27 using System;
  28 using System.Collections;
  29 using System.Xml;
  30 using System.IO;
  31
  32 namespace Beagle.Util {
  33
  34         public class ImBuddy {
  35                 public string Protocol = "";
  36                 public string OwnerAccountName = "";
  37                 public string BuddyAccountName = "";
  38                 public string Alias = "";
  39                 public string BuddyIconLocation = "";
  40                 public string BuddyIconChecksum = "";
  41
  42                 public ImBuddy (string protocol, string owneraccount, string buddyaccount, string alias, string iconlocation, string iconchecksum) {
  43                         Protocol = protocol;
  44                         OwnerAccountName = owneraccount;
  45                         BuddyAccountName = buddyaccount;
  46                         Alias = alias;
  47                         BuddyIconLocation = iconlocation;
  48                         BuddyIconChecksum = iconchecksum;
  49                 }
  50         }
  51
  52         ///////////////////////////////////////////////////////////////////////////////
  53
  54         public abstract class ImBuddyListReader {
  55
  56                 public bool verbose = false;
  57
  58                 public Hashtable buddyList = new Hashtable ();
  59
  60                 abstract public void Read ();
  61
  62                 public void DebugPrint (string str) {
  63                         if (!verbose)
  64                                 return;
  65                         Logger.Log.Debug ("{0}", str);
  66                 }
  67
  68                 public class ImBuddyComparer : IComparer {
  69
  70                         int IComparer.Compare (Object x, Object y) {
  71                                 string accountx, accounty;
  72
  73                                 try {
  74                                         accountx = ((ImBuddy) x).BuddyAccountName;
  75                                 } catch {
  76                                         accountx = "";
  77                                 }
  78
  79                                 try {
  80                                         accounty = ((ImBuddy) y).BuddyAccountName;
  81                                 } catch {
  82                                         accounty = "";
  83                                 }
  84
  85                                 return System.String.Compare (accountx, accounty);
  86                         }
  87                 }
  88
  89                 public class ImBuddyAliasComparer : IComparer {
  90
  91                         int IComparer.Compare (Object x, Object y) {
  92                                 try {
  93                                         return System.String.Compare ((string)x, ((ImBuddy) y).BuddyAccountName);
  94                                 } catch {
  95                                         return System.String.Compare (((ImBuddy) x).BuddyAccountName, (string)y);
  96                                 }
  97                         }
  98                 }
  99         }
 100
 101         public class GaimBuddyListReader : ImBuddyListReader {
 102
 103                 string buddyListPath;
 104                 string buddyListDir;
 105                 DateTime buddyListLastWriteTime;
 106                 uint timeoutId;
 107
 108                 public GaimBuddyListReader ()
 109                 {
 110                         string home = Environment.GetEnvironmentVariable ("HOME");
 111                         buddyListDir = Path.Combine (home, ".gaim");
 112                         buddyListPath = Path.Combine (buddyListDir, "blist.xml");
 113
 114                         if (File.Exists (buddyListPath))
 115                                 Read ();
 116
 117                         // Poll the file once every minute
 118                         timeoutId = GLib.Timeout.Add (60000, new GLib.TimeoutHandler (ReadTimeoutHandler));
 119                 }
 120
 121                 ~GaimBuddyListReader ()
 122                 {
 123                         if (timeoutId > 0)
 124                                 GLib.Source.Remove (timeoutId);
 125                 }
 126
 127                 private bool ReadTimeoutHandler ()
 128                 {
 129                         if (File.Exists (buddyListPath))
 130                                 Read ();
 131
 132                         return true;
 133                 }
 134
 135                 private string Format (string name) {
 136                         return name.ToLower ().Replace (" ", "");
 137                 }
 138
 139                 override public void Read ()
 140                 {
 141                         // If the file hasn't changed, don't do anything.
 142                         DateTime last_write = File.GetLastWriteTime (buddyListPath);
 143                         if (last_write == buddyListLastWriteTime)
 144                                 return;
 145
 146                         buddyListLastWriteTime = last_write;
 147
 148                         buddyList = new Hashtable ();
 149
 150                         try {
 151                                 XmlDocument accounts = new XmlDocument ();
 152                                 accounts.Load (buddyListPath);
 153
 154                                 XmlNodeList contacts = accounts.SelectNodes ("//contact");
 155
 156                                 foreach (XmlNode contact in contacts) {
 157                                         string groupalias = "";
 158
 159                                         foreach (XmlAttribute attr in contact.Attributes) {
 160                                                 if (attr.Name == "alias") {
 161                                                         groupalias = attr.Value;
 162                                                 }
 163                                         }
 164
 165                                         if (groupalias != "") {
 166                                                 foreach (XmlNode buddy in contact.ChildNodes) {
 167                                                         AddBuddy (buddy, groupalias);
 168                                                 }
 169                                         }
 170                                 }
 171
 172                                 foreach (XmlNode buddy in accounts.SelectNodes ("//contact[not(@name)]/buddy")) {
 173                                         AddBuddy (buddy);
 174                                 }
 175                         } catch (Exception ex) {
 176                                 Logger.Log.Error ("Caught exception while trying to parse Gaim contact list: {0}", ex.Message);
 177                         }
 178                 }
 179
 180                 private void AddBuddy (XmlNode buddy, string groupalias)
 181                 {
 182                         string protocol, owner, other, alias, iconlocation, iconchecksum;
 183
 184                         protocol = "";
 185                         owner = "";
 186                         other = "";
 187                         alias = "";
 188                         iconlocation = "";
 189                         iconchecksum = "";
 190
 191                         foreach (XmlAttribute attr in buddy.Attributes) {
 192                                 switch (attr.Name) {
 193                                         case "account":
 194                                                 owner = attr.Value;
 195                                                 DebugPrint ("owner: " + owner);
 196                                                 break;
 197                                         case "proto":
 198                                         protocol = attr.Value;
 199                                         DebugPrint ("protocol: " + protocol);
 200                                         break;
 201                                 }
 202                         }
 203
 204                         foreach (XmlNode attr in buddy.ChildNodes) {
 205                                 switch (attr.LocalName) {
 206                                         case "name":
 207                                                 other = attr.InnerText;
 208                                                 DebugPrint ("other: " + other);
 209                                                 break;
 210                                         case "alias":
 211                                                 alias = attr.InnerText;
 212                                                 DebugPrint ("alias: " + alias);
 213                                                 break;
 214                                         case "setting":
 215                                                 foreach (XmlAttribute subattr in attr.Attributes) {
 216                                                         if (subattr.Name == "name" && subattr.Value == "buddy_icon")
 217                                                         {
 218                                                                 iconlocation = attr.InnerText;
 219                                                                 DebugPrint ("iconlocation: " + iconlocation);
 220                                                         }
 221                                                         else if ( subattr.Name == "name" && subattr.Value == "icon_checksum")
 222                                                         {
 223                                                                 iconchecksum = attr.InnerText;
 224                                                                 DebugPrint ("iconchecksum: " + iconchecksum);
 225                                                         }
 226                                                 }
 227                                                 break;
 228                                 }
 229                         }
 230
 231                         ImBuddy old;
 232
 233                         alias = groupalias;
 234
 235                         if (buddyList.ContainsKey (Format(other))) {
 236                                 old = (ImBuddy)buddyList[Format(other)];
 237                                 if (old.Alias == "" && alias != "")
 238                                         old.Alias = alias;
 239                                 if (old.BuddyIconLocation == "" && iconlocation == "") {
 240                                         old.BuddyIconLocation = iconlocation;
 241                                         old.BuddyIconChecksum = iconchecksum;
 242                                 }
 243                                 buddyList.Remove (Format(other));
 244                                 buddyList.Add (Format(other), old);
 245                         }
 246                         else
 247                                 buddyList.Add (Format(other), new ImBuddy (protocol, owner, Format(other), alias, iconlocation, iconchecksum));
 248                 }
 249
 250                 private void AddBuddy (XmlNode buddy)
 251                 {
 252                         string protocol, owner, other, alias, iconlocation, iconchecksum;
 253
 254                         protocol = "";
 255                         owner = "";
 256                         other = "";
 257                         alias = "";
 258                         iconlocation = "";
 259                         iconchecksum = "";
 260
 261                         foreach (XmlAttribute attr in buddy.Attributes) {
 262                                 switch (attr.Name) {
 263                                         case "account":
 264                                                 owner = attr.Value;
 265                                                 DebugPrint ("owner: " + owner);
 266                                                 break;
 267                                         case "proto":
 268                                         protocol = attr.Value;
 269                                         DebugPrint ("protocol: " + protocol);
 270                                         break;
 271                                 }
 272                         }
 273
 274                         foreach (XmlNode attr in buddy.ChildNodes) {
 275                                 switch (attr.LocalName) {
 276                                         case "name":
 277                                                 other = attr.InnerText;
 278                                                 DebugPrint ("other: " + other);
 279                                                 break;
 280                                         case "alias":
 281                                                 alias = attr.InnerText;
 282                                                 DebugPrint ("alias: " + alias);
 283                                                 break;
 284                                         case "setting":
 285                                                 foreach (XmlAttribute subattr in attr.Attributes) {
 286                                                         if (subattr.Name == "name" && subattr.Value == "buddy_icon")
 287                                                         {
 288                                                                 iconlocation = attr.InnerText;
 289                                                                 DebugPrint ("iconlocation: " + iconlocation);
 290                                                         }
 291                                                         else if ( subattr.Name == "name" && subattr.Value == "icon_checksum")
 292                                                         {
 293                                                                 iconchecksum = attr.InnerText;
 294                                                                 DebugPrint ("iconchecksum: " + iconchecksum);
 295                                                         }
 296                                                 }
 297                                                 break;
 298                                 }
 299                         }
 300
 301                         ImBuddy old;
 302
 303                         if (buddyList.ContainsKey (Format(other))) {
 304                                 old = (ImBuddy)buddyList[Format(other)];
 305                                 if (old.Alias == "" && alias != "")
 306                                         old.Alias = alias;
 307                                 if (old.BuddyIconLocation == "" && iconlocation == "") {
 308                                         old.BuddyIconLocation = iconlocation;
 309                                         old.BuddyIconChecksum = iconchecksum;
 310                                 }
 311                                 buddyList.Remove (Format(other));
 312                                 buddyList.Add (Format(other), old);
 313                         }
 314                         else
 315                                 buddyList.Add (Format(other), new ImBuddy (protocol, owner, Format(other), alias, iconlocation, iconchecksum));
 316                 }
 317
 318
 319                 public ImBuddy Search (string buddy) {
 320                         return (ImBuddy)buddyList[Format(buddy)];
 321                 }
 322
 323         }
 324
 325         /////////////////////////////////////////////////////////////
 326
 327         public class KopeteBuddyListReader : ImBuddyListReader {
 328
 329                 string buddyListPath;
 330                 string buddyListDir;
 331                 DateTime buddyListLastWriteTime;
 332                 uint timeoutId;
 333
 334                 public KopeteBuddyListReader ()
 335                 {
 336                         buddyListDir = Path.Combine (PathFinder.HomeDir, ".kde/share/apps/kopete");
 337                         buddyListPath = Path.Combine (buddyListDir, "contactlist.xml");
 338
 339                         if (File.Exists (buddyListPath))
 340                                 Read ();
 341
 342                         // Poll the file once every minute
 343                         timeoutId = GLib.Timeout.Add (60000, new GLib.TimeoutHandler (ReadTimeoutHandler));
 344                 }
 345
 346                 ~KopeteBuddyListReader ()
 347                 {
 348                         if (timeoutId > 0)
 349                                 GLib.Source.Remove (timeoutId);
 350                 }
 351
 352                 private bool ReadTimeoutHandler ()
 353                 {
 354                         if (File.Exists (buddyListPath))
 355                                 Read ();
 356
 357                         return true;
 358                 }
 359
 360                 private string Format (string name) {
 361                         return name.ToLower ().Replace (" ", "");
 362                 }
 363
 364                 override public void Read ()
 365                 {
 366                         // If the file hasn't changed, don't do anything.
 367                         DateTime last_write = File.GetLastWriteTime (buddyListPath);
 368                         if (last_write == buddyListLastWriteTime)
 369                                 return;
 370
 371                         buddyListLastWriteTime = last_write;
 372
 373                         buddyList = new Hashtable ();
 374
 375                         try {
 376                                 XmlDocument accounts = new XmlDocument ();
 377                                 accounts.Load (buddyListPath);
 378
 379                                 // Find all xml contact nodes in the contact list
 380                                 foreach (XmlNode contact in accounts.SelectNodes ("//meta-contact"))
 381                                         AddContact (contact);
 382                         } catch (Exception ex) {
 383                                 Logger.Log.Error ("Caught exception while trying to parse Kopete contact list: {0}", ex.Message);
 384                         }
 385                 }
 386
 387                 private void AddContact (XmlNode contact)
 388                 {
 389                         string protocol, owner, other, alias, iconlocation, iconchecksum;
 390
 391                         protocol = "";
 392                         owner = "";
 393                         other = "";
 394                         alias = "";
 395                         iconlocation = "";
 396                         iconchecksum = "";
 397
 398                         // For each and every meta-contact, there can be multiple
 399                         // buddy information entries if we have a contact added on
 400                         // multiple protocols. Loop through them.
 401
 402                         foreach (XmlNode plugin_node in contact.SelectNodes ("plugin-data")) {
 403                                 // Determin the protocol
 404                                 XmlAttribute plugin_id_attr = plugin_node.Attributes ["plugin-id"];
 405                                 protocol = plugin_id_attr.Value.Substring (0, plugin_id_attr.Value.Length-8).ToLower ();
 406                                 DebugPrint ("Protocol=" + protocol);
 407
 408                                 // Fetch all the buddy properties
 409                                 foreach (XmlNode plugin_data_node in plugin_node.SelectNodes ("plugin-data-field")) {
 410                                         switch (plugin_data_node.Attributes ["key"].Value) {
 411                                         case "contactId":
 412                                                 other = plugin_data_node.InnerText;
 413                                                 DebugPrint ("Screen=" + other);
 414                                                 break;
 415                                         case "accountId":
 416                                                 owner = plugin_data_node.InnerText;
 417                                                 DebugPrint ("Account=" + owner);
 418                                                 break;
 419                                         case "displayName":
 420                                                 alias = plugin_data_node.InnerText;
 421                                                 DebugPrint ("Alias=" + alias);
 422                                                 break;
 423                                         }
 424                                 }
 425
 426                                 // Replace any earlier buddies with the same screenname
 427                                 // FIXME: Not safe since we can have the same screenname on different accounts.
 428                                 if (buddyList.ContainsKey (Format(other)))
 429                                         buddyList.Remove (Format(other));
 430
 431                                 buddyList.Add (Format(other), new ImBuddy (protocol, owner, Format(other), alias, iconlocation, iconchecksum));
 432                         }
 433                 }
 434
 435
 436                 public ImBuddy Search (string buddy) {
 437                         return (ImBuddy)buddyList[Format(buddy)];
 438                 }
 439         }
 440 }