Renderers/MailMessageHitRenderer.cs

   1 //
   2 // GNOME Dashboard
   3 //
   4 // MailMessageMatchRenderer.cs: Knows how to render MailMessage matches.
   5 //
   6 // Author:
   7 //   Kevin Godby <godbyk@yahoo.com>
   8 //
   9 // FIXME: Add support for importance flag (if possible)
  10 // FIXME: Output date in local format (internationalization) -- Is this working now?
  11
  12 //
  13 // Copyright (C) 2003, 2004 Kevin Godby
  14 // Copyright (C) 2004 Novell, Inc.
  15 //
  16 // Permission is hereby granted, free of charge, to any person obtaining a copy
  17 // of this software and associated documentation files (the "Software"), to deal
  18 // in the Software without restriction, including without limitation the rights
  19 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  20 // copies of the Software, and to permit persons to whom the Software is
  21 // furnished to do so, subject to the following conditions:
  22 //
  23 // The above copyright notice and this permission notice shall be included in all
  24 // copies or substantial portions of the Software.
  25 //
  26 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  27 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  28 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  29 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  30 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  31 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  32 // SOFTWARE.
  33 //
  34
  35
  36 using System;
  37 using System.Collections;
  38 using System.IO;
  39 using System.Xml;
  40 using System.Globalization;
  41
  42 //[assembly:Dashboard.MatchRendererFactory ("Dashboard.MailMessageMatchRenderer")]
  43
  44 namespace Beagle {
  45
  46         public class MailMessageHitRenderer : HitRendererHtml {
  47
  48                 public MailMessageHitRenderer ()
  49                 {
  50                         type = "MailMessage";
  51                 }
  52
  53                 protected override string HitsToHtml (ArrayList hits)
  54                 {
  55                         DateTime StartExec = DateTime.Now;
  56
  57                         StringWriter sw = new StringWriter ();
  58                         XmlWriter xw = new XmlTextWriter (sw);
  59
  60                         // Start the xhtml block
  61                         xw.WriteStartElement ("div");
  62
  63                         // Title of block
  64                         xw.WriteStartElement ("table");
  65                         xw.WriteAttributeString ("border", "0");
  66                         xw.WriteAttributeString ("width", "100%");
  67                         xw.WriteStartElement ("tr");
  68                         xw.WriteStartElement ("td");
  69                         xw.WriteAttributeString ("bgcolor", "#fffa6e");
  70                         xw.WriteStartElement ("font");
  71                         xw.WriteAttributeString ("size", "+2");
  72                         xw.WriteString ("Email Messages");
  73                         xw.WriteEndElement ();  // font
  74                         xw.WriteEndElement ();  // td
  75                         xw.WriteEndElement ();  // tr
  76                         xw.WriteEndElement ();  // table
  77
  78                         // The table of data
  79                         xw.WriteStartElement ("table");
  80                         xw.WriteAttributeString ("border", "0");
  81                         xw.WriteAttributeString ("cellpadding", "0");
  82                         xw.WriteAttributeString ("cellspacing", "0");
  83                         xw.WriteAttributeString ("width", "100%");
  84
  85                         // Sort results by date (newest first)
  86                         IComparer mailmessagedatecomparer = new MailMessageDateComparer ();
  87                         hits.Sort (mailmessagedatecomparer);
  88
  89                         bool color_band = true;
  90                         foreach (Hit hit in hits) {
  91                                 HTMLRenderSingleMailMessage (hit, color_band, xw);
  92                                 color_band = ! color_band;
  93                         }
  94
  95                         xw.WriteEndElement (); // table
  96                         xw.WriteEndElement (); // div
  97
  98                         // close the xhtml doc
  99                         xw.Close ();
 100
 101                         // Console.WriteLine ("..Renderer: MailMessage.. elapsed time {0}", DateTime.Now - StartExec);
 102
 103                         return sw.ToString ();
 104                 }
 105
 106                 private void HTMLRenderSingleMailMessage (Hit hit, bool color_band, XmlWriter xw)
 107                 {
 108                         // Make the date look pretty
 109                         string maildate = Convert.ToString (hit ["SentDate"]);
 110                         string ParsedDate = ParseMailDate (maildate);
 111
 112                         Message msg = new Message ();
 113                         msg.Initialize (hit);
 114
 115                         // Console.WriteLine ("To: {0}\nFrom: {1}\nSubject: {2}\nDate: {3}",
 116                         //                      msg.Recipient, msg.Sender, msg.Subject, msg.SentDate);
 117
 118                         xw.WriteStartElement ("tr");
 119                         if (color_band)
 120                                 xw.WriteAttributeString ("bgcolor", "#eeeeee");
 121
 122                         xw.WriteStartElement ("a");
 123                         xw.WriteAttributeString ("href", "exec:evolution-1.5 " + hit.Uri); // FIXME: Probably unsafe
 124                         xw.WriteAttributeString ("style", "text-decoration: none; color: black;");
 125
 126                         // new / read / replied-to icon
 127                         xw.WriteStartElement ("td");
 128                         xw.WriteAttributeString ("width", "1%");
 129                         xw.WriteAttributeString ("valign", "top");
 130                         xw.WriteStartElement ("img");
 131                         xw.WriteAttributeString ("border", "0");
 132                         xw.WriteAttributeString ("src", msg.Icon);
 133                         xw.WriteEndElement (); // img
 134                         xw.WriteEndElement (); // td
 135
 136                         // sender (mail from)
 137                         xw.WriteStartElement ("td");
 138                         // xw.WriteAttributeString ("nowrap", "true");
 139                         xw.WriteAttributeString ("width", "98%");
 140                         xw.WriteRaw (MarkupStatus (msg.GetSenderName (), msg));
 141                         xw.WriteEndElement (); // td
 142
 143                         // date
 144                         xw.WriteStartElement ("td");
 145                         xw.WriteAttributeString ("colspan", "2");
 146                         xw.WriteAttributeString ("align", "right");
 147                         xw.WriteAttributeString ("nowrap", "1");
 148                         xw.WriteAttributeString ("valign", "top");
 149                         xw.WriteAttributeString ("width", "1%");
 150                         xw.WriteRaw (MarkupStatus (ParsedDate, msg));
 151                         xw.WriteEndElement (); // td
 152                         xw.WriteEndElement (); // a href
 153                         xw.WriteEndElement (); // tr
 154
 155                         xw.WriteStartElement ("tr");
 156                         if (color_band)
 157                                 xw.WriteAttributeString ("bgcolor", "#eeeeee");
 158
 159                         xw.WriteStartElement ("a");
 160                         xw.WriteAttributeString ("href", "exec:evolution-1.5 " + hit.Uri); // FIXME: Probably unsafe
 161                         xw.WriteAttributeString ("style", "text-decoration: none; color: black");
 162
 163                         // attachment icon
 164                         xw.WriteStartElement ("td");
 165                         xw.WriteAttributeString ("width", "1%");
 166                         xw.WriteAttributeString ("valign", "top");
 167                         xw.WriteAttributeString ("align", "right");
 168
 169                         if (msg.HasAttachment) {
 170                                 xw.WriteStartElement ("img");
 171                                 xw.WriteAttributeString ("border", "0");
 172                                 xw.WriteAttributeString ("src", "internal:attachment.png");
 173                                 xw.WriteEndElement (); // img
 174                         }
 175
 176                         xw.WriteEndElement (); // td
 177
 178                         // subject
 179                         xw.WriteStartElement ("td");
 180                         xw.WriteAttributeString ("colspan", "2");
 181                         xw.WriteAttributeString ("width", "98%");
 182                         xw.WriteAttributeString ("valign", "top");
 183                         xw.WriteStartElement ("font");
 184                         xw.WriteAttributeString ("color", "#666666");
 185                         xw.WriteRaw (MarkupStatus (msg.Subject, msg));
 186                         xw.WriteEndElement (); // font
 187                         xw.WriteEndElement (); // td
 188
 189                         xw.WriteEndElement (); // a href
 190                         xw.WriteEndElement (); // tr
 191                 }
 192
 193                 private string ParseMailDate (string maildate)
 194                 {
 195                         // The dates returned by these functions are UTC
 196                         DateTime ParsedDate = DateTime.Parse (maildate);
 197                         DateTime today      = DateTime.Today;
 198
 199                         // Display in the current time zone
 200                         TimeZone localZone = TimeZone.CurrentTimeZone;
 201                         ParsedDate = localZone.ToLocalTime (ParsedDate);
 202
 203                         // Let's see if we can't use the proper date and time formats here...
 204                         CultureInfo ci = new CultureInfo (CultureInfo.CurrentCulture.Name);
 205
 206                         if (today.Date == ParsedDate.Date) {
 207                                 // Display the time only
 208                                 return ParsedDate.ToString ("t", ci);
 209                         }
 210
 211                         if (today.Year != ParsedDate.Year) {
 212                                 // Show the year mm/dd/yyyy or dd/mm/yyyy
 213                                 return ParsedDate.ToString ("d", ci);
 214                         }
 215
 216                         return ParsedDate.ToString ("ddd, MMM d");
 217                 }
 218
 219                 private string MakeHTMLSafe (string html)
 220                 {
 221                         StringWriter sw = new StringWriter ();
 222                         XmlWriter xw = new XmlTextWriter (sw);
 223                         xw.WriteString (html);
 224                         string safehtml = sw.ToString ();
 225                         xw.Close ();
 226                         sw.Close ();
 227
 228                         return safehtml;
 229                 }
 230
 231                 private string MarkupStatus (string html, Message msg)
 232                 {
 233                         StringWriter sw = new StringWriter ();
 234                         XmlWriter xw = new XmlTextWriter (sw);
 235
 236                         if (msg.IsDeleted == true)
 237                                 xw.WriteStartElement ("strike");
 238                         if (msg.IsNew == true)
 239                                 xw.WriteStartElement ("b");
 240
 241                         xw.WriteRaw (MakeHTMLSafe (html));
 242
 243                         if (msg.IsNew == true)
 244                                 xw.WriteEndElement (); // b
 245                         if (msg.IsDeleted == true)
 246                                 xw.WriteEndElement (); //strike
 247
 248                         html = sw.ToString ();
 249
 250                         return html;
 251
 252                 }
 253
 254                 // this might fare better in utils/evolution/camel.cs
 255                 public enum CamelFlags {
 256                         ANSWERED     = 1<<0,
 257                         DELETED      = 1<<1,
 258                         DRAFT        = 1<<2,
 259                         FLAGGED      = 1<<3,
 260                         SEEN         = 1<<4,
 261                         ATTACHMENTS  = 1<<5,
 262                         ANSWERED_ALL = 1<<6,
 263                         UNKNOWN_7    = 1<<7,
 264                         UNKNOWN_8    = 1<<8
 265                 }
 266
 267                 private int GetDateStamp (string maildate)
 268                 {
 269                         DateTime xdate = DateTime.Parse (maildate);
 270                         int DateStamp = int.Parse (maildate);
 271                         return DateStamp;
 272                 }
 273
 274                 public class Message {
 275                         private string subject;
 276                         private string sender;
 277                         private DateTime sentdate;
 278                         private string icon;
 279                         private string recipient;
 280                         private string uid;
 281                         private bool hasreply;
 282                         private bool isdeleted;
 283                         private bool isdraft;
 284                         private bool isflagged;
 285                         private bool isnew;
 286                         private bool hasattachment;
 287                         private string sendername;
 288                         private string senderaddress;
 289
 290                         public string Subject {
 291                                 get { return this.subject; }
 292                                 set { this.subject = value; }
 293                         }
 294
 295                         public string Sender {
 296                                 get { return this.sender; }
 297                                 set { this.sender = value; }
 298                         }
 299
 300                         public DateTime SentDate {
 301                                 get { return this.sentdate; }
 302                                 set { this.sentdate = value; }
 303                         }
 304
 305                         public string Icon {
 306                                 get { return this.icon; }
 307                                 set { this.icon = value; }
 308                         }
 309
 310                         public string Recipient {
 311                                 get { return this.recipient; }
 312                                 set { this.recipient = value; }
 313                         }
 314
 315                         public string UID {
 316                                 get { return this.uid; }
 317                                 set { this.uid = value; }
 318                         }
 319
 320                         public bool HasAttachment {
 321                                 get { return this.hasattachment; }
 322                                 set { this.hasattachment = value; }
 323                         }
 324
 325                         public bool HasReply {
 326                                 get { return this.hasreply; }
 327                                 set { this.hasreply = value; }
 328                         }
 329
 330                         public bool IsDeleted {
 331                                 get { return this.isdeleted; }
 332                                 set { this.isdeleted = value; }
 333                         }
 334
 335                         public bool IsDraft {
 336                                 get { return this.isdraft; }
 337                                 set { this.isdraft = value; }
 338                         }
 339
 340                         public bool IsFlagged {
 341                                 get { return this.isflagged; }
 342                                 set { this.isflagged = value; }
 343                         }
 344
 345                         public bool IsNew {
 346                                 get { return this.isnew; }
 347                                 set { this.isnew = value; }
 348                         }
 349
 350                         public string GetSenderName ()
 351                         {
 352                                 if (this.sender.IndexOf ("<") == -1)
 353                                         this.sendername = this.sender;
 354                                 else
 355                                         this.sendername = this.sender.Substring (0, (this.sender.LastIndexOf ("<") - 1));
 356
 357                                 return this.sendername;
 358                         }
 359
 360                         public string GetIcon ()
 361                         {
 362                                 if (this.hasreply) {
 363                                         this.icon = "internal:mail-replied.png";
 364                                 } else if (this.IsNew) {
 365                                         this.icon = "internal:mail-new.png";
 366                                 } else {
 367                                         this.icon = "internal:mail-read.png";
 368                                 }
 369
 370                                 return this.icon;
 371                         }
 372
 373                         public void Initialize (Hit hit)
 374                         {
 375                                 // Set all the properties based on info from the provided Match
 376                                 this.subject   = Convert.ToString (hit ["Subject"]);
 377                                 this.sender    = Convert.ToString (hit ["From"]);
 378                                 this.recipient = Convert.ToString (hit ["To"]);
 379                                 this.sentdate  = DateTime.Parse (Convert.ToString (hit ["SentDate"]));
 380                                 this.uid       = Convert.ToString (hit ["UID"]);
 381
 382                                 // this.sendername = this.sender.Substring (0, (this.sender.LastIndexOf ("<") - 1));
 383
 384                                 // Parse the message flags
 385                                 int flags = int.Parse (Convert.ToString (hit ["Flags"]));
 386
 387                                 if ((flags & (int) CamelFlags.ANSWERED) == (int) CamelFlags.ANSWERED)
 388                                         this.hasreply = true;
 389
 390                                 if ((flags & (int) CamelFlags.DELETED) == (int) CamelFlags.DELETED)
 391                                         this.isdeleted = true;
 392
 393                                 if ((flags & (int) CamelFlags.DRAFT) == (int) CamelFlags.DRAFT)
 394                                         this.isdraft = true;
 395
 396                                 if ((flags & (int) CamelFlags.FLAGGED) == (int) CamelFlags.FLAGGED)
 397                                         this.isflagged = true;
 398
 399                                 if ((flags & (int) CamelFlags.SEEN) == (int) CamelFlags.SEEN) {
 400                                         this.isnew = false;
 401                                 } else {
 402                                         this.isnew = true;
 403                                 }
 404
 405                                 if ((flags & (int) CamelFlags.ATTACHMENTS) == (int) CamelFlags.ATTACHMENTS)
 406                                         this.hasattachment = true;
 407
 408                                 if ((flags & (int) CamelFlags.ANSWERED_ALL) == (int) CamelFlags.ATTACHMENTS)
 409                                         this.hasreply = true;
 410
 411                                 // Generate the icon
 412                                 if (this.hasreply) {
 413                                         this.icon = "internal:mail-replied.png";
 414                                 } else if (this.isnew) {
 415                                         this.icon = "internal:mail-new.png";
 416                                 } else {
 417                                         this.icon = "internal:mail-read.png";
 418                                 }
 419                         }
 420                 }
 421         }
 422
 423
 424         public enum SortDirection {
 425                 Ascending,
 426                 Descending
 427         }
 428
 429         public class MailMessageDateComparer : IComparer {
 430
 431                 // Reverse-sort -- newest messages first
 432                 private SortDirection m_direction = SortDirection.Descending;
 433
 434                 int IComparer.Compare (Object x, Object y) {
 435
 436                         Hit matchX = (Hit) x;
 437                         Hit matchY = (Hit) y;
 438
 439                         DateTime DateX = DateTime.Parse (Convert.ToString (matchX ["SentDate"]));
 440                         DateTime DateY = DateTime.Parse (Convert.ToString (matchY ["SentDate"]));
 441
 442                         if (matchX == null && matchY == null) {
 443                                 return 0;
 444                         } else if (matchX == null && matchY != null) {
 445                                 return (this.m_direction == SortDirection.Ascending) ? -1 : 1;
 446                         } else if (matchX != null && matchY == null) {
 447                                 return (this.m_direction == SortDirection.Ascending) ? 1 : -1;
 448                         } else {
 449                                 return (this.m_direction == SortDirection.Ascending) ?
 450                                         DateX.CompareTo (DateY) :
 451                                         DateY.CompareTo (DateX);
 452                         }
 453                 }
 454         }
 455
 456
 457
 458 }