beagled/KopeteQueryable/KopeteQueryable.cs

   1 //
   2 // KopeteQueryable.cs
   3 //
   4 // Copyright (C) 2005 Novell, Inc.
   5 //
   6
   7 //
   8 // Permission is hereby granted, free of charge, to any person obtaining a
   9 // copy of this software and associated documentation files (the "Software"),
  10 // to deal in the Software without restriction, including without limitation
  11 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12 // and/or sell copies of the Software, and to permit persons to whom the
  13 // Software is furnished to do so, subject to the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be included in
  16 // all 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
  23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24 // DEALINGS IN THE SOFTWARE.
  25 //
  26
  27 using System;
  28 using System.Collections;
  29 using System.IO;
  30 using System.Text;
  31 using System.Threading;
  32
  33 using Beagle.Daemon;
  34 using Beagle.Util;
  35
  36 namespace Beagle.Daemon.KopeteQueryable {
  37
  38         [QueryableFlavor (Name="Kopete", Domain=QueryDomain.Local, RequireInotify=false)]
  39         public class KopeteQueryable : LuceneFileQueryable {
  40
  41                 private string config_dir, log_dir;
  42
  43                 private int polling_interval_in_seconds = 60;
  44
  45                 private KopeteCrawler crawler;
  46
  47                 private KopeteBuddyListReader list = new KopeteBuddyListReader ();
  48
  49                 public KopeteQueryable () : base ("KopeteIndex")
  50                 {
  51                         config_dir = Path.Combine (PathFinder.HomeDir, ".kde/share/apps/kopete");
  52                         log_dir = Path.Combine (config_dir, "logs");
  53                 }
  54
  55                 /////////////////////////////////////////////////
  56
  57                 private void StartWorker()
  58                 {
  59                         if (! Directory.Exists (log_dir)) {
  60                                 GLib.Timeout.Add (60000, new GLib.TimeoutHandler (CheckForExistence));
  61                                 return;
  62                         }
  63
  64                         Logger.Log.Info ("Starting Kopete log backend");
  65
  66                         Stopwatch stopwatch = new Stopwatch ();
  67                         stopwatch.Start ();
  68
  69                         if (Inotify.Enabled)
  70                                 Watch (log_dir);
  71
  72                         crawler = new KopeteCrawler (log_dir);
  73                         Crawl ();
  74
  75                         if (!Inotify.Enabled) {
  76                                 Scheduler.Task task = Scheduler.TaskFromHook (new Scheduler.TaskHook (CrawlHook));
  77                                 task.Tag = "Crawling ~/.kopete/logs to find new logfiles";
  78                                 ThisScheduler.Add (task);
  79                         }
  80
  81                         stopwatch.Stop ();
  82
  83                         Logger.Log.Info ("Kopete log backend worker thread done in {0}", stopwatch);
  84                 }
  85
  86                 public override void Start ()
  87                 {
  88                         base.Start ();
  89
  90                         ExceptionHandlingThread.Start (new ThreadStart (StartWorker));
  91                 }
  92
  93                 /////////////////////////////////////////////////
  94
  95                 private void Crawl ()
  96                 {
  97                         crawler.Crawl ();
  98                         foreach (FileInfo file in crawler.Logs) {
  99                                 IndexLog (file.FullName, Scheduler.Priority.Delayed);
 100                         }
 101                 }
 102
 103                 private void CrawlHook (Scheduler.Task task)
 104                 {
 105                         Crawl ();
 106                         task.Reschedule = true;
 107                         task.TriggerTime = DateTime.Now.AddSeconds (polling_interval_in_seconds);
 108                 }
 109
 110                 /////////////////////////////////////////////////
 111
 112                 // Sets up an Inotify watch on all subdirectories withing ~/.kopete/logs
 113                 private void Watch (string path)
 114                 {
 115                         DirectoryInfo root = new DirectoryInfo (path);
 116
 117                         if (! root.Exists)
 118                                 return;
 119
 120                         Queue queue = new Queue ();
 121                         queue.Enqueue (root);
 122
 123                         while (queue.Count > 0) {
 124                                 DirectoryInfo dir = queue.Dequeue () as DirectoryInfo;
 125
 126                                 // Setup watches on the present directory.
 127                                 Inotify.Subscribe (dir.FullName, OnInotifyEvent,
 128                                                    Inotify.EventType.Create | Inotify.EventType.CloseWrite);
 129
 130                                 // Add all subdirectories to the queue so their files can be indexed.
 131                                 foreach (DirectoryInfo subdir in dir.GetDirectories ())
 132                                         queue.Enqueue (subdir);
 133                         }
 134                 }
 135
 136                 /////////////////////////////////////////////////
 137
 138                 private bool CheckForExistence ()
 139                 {
 140                         if (!Directory.Exists (log_dir))
 141                                 return true;
 142
 143                         this.Start ();
 144
 145                         return false;
 146                 }
 147
 148                 /////////////////////////////////////////////////
 149
 150                 private void OnInotifyEvent (Inotify.Watch watch,
 151                                              string path,
 152                                              string subitem,
 153                                              string srcpath,
 154                                              Inotify.EventType type)
 155                 {
 156                         if (subitem == "")
 157                                 return;
 158
 159                         string full_path = Path.Combine (path, subitem);
 160
 161                         if ((type & Inotify.EventType.Create) != 0 && (type & Inotify.EventType.IsDirectory) != 0) {
 162                                 Watch (full_path);
 163                                 return;
 164                         }
 165
 166                         if ((type & Inotify.EventType.Modify) != 0) {
 167                                 IndexLog (full_path, Scheduler.Priority.Immediate);
 168                                 return;
 169                         }
 170                 }
 171
 172                 /////////////////////////////////////////////////
 173
 174                 private static Indexable ImLogToIndexable (ImLog log)
 175                 {
 176                         Indexable indexable = new Indexable (log.Uri);
 177                         indexable.Timestamp = log.Timestamp;
 178                         indexable.MimeType = "text/plain";
 179                         indexable.Type = "IMLog";
 180
 181                         StringBuilder text = new StringBuilder ();
 182                         foreach (ImLog.Utterance utt in log.Utterances) {
 183                                 //Console.WriteLine ("[{0}][{1}]", utt.Who, utt.Text);
 184                                 text.Append (utt.Text);
 185                                 text.Append (" ");
 186                         }
 187
 188                         indexable.AddProperty (Property.NewKeyword ("fixme:file", log.LogFile));
 189                         indexable.AddProperty (Property.NewKeyword ("fixme:offset", log.LogOffset));
 190                         indexable.AddProperty (Property.NewDate ("fixme:starttime", log.StartTime));
 191                         indexable.AddProperty (Property.NewKeyword ("fixme:speakingto", log.SpeakingTo));
 192                         indexable.AddProperty (Property.NewKeyword ("fixme:identity", log.Identity));
 193                         indexable.AddProperty (Property.NewDate ("fixme:endtime", log.EndTime));
 194
 195                         indexable.AddProperty (Property.New ("fixme:client", log.Client));
 196                         indexable.AddProperty (Property.New ("fixme:protocol", log.Protocol));
 197
 198                         StringReader reader = new StringReader (text.ToString ());
 199                         indexable.SetTextReader (reader);
 200
 201                         return indexable;
 202                 }
 203
 204                 private void IndexLog (string filename, Scheduler.Priority priority)
 205                 {
 206                         FileInfo info = new FileInfo (filename);
 207                         if (! info.Exists)
 208                                 return;
 209
 210                         if (IsUpToDate (filename))
 211                                 return;
 212
 213                         ICollection logs = KopeteLog.ScanLog (info);
 214                         foreach (ImLog log in logs) {
 215                                 Indexable indexable = ImLogToIndexable (log);
 216                                 Scheduler.Task task = NewAddTask (indexable);
 217                                 task.Priority = priority;
 218                                 task.SubPriority = 0;
 219                                 ThisScheduler.Add (task);
 220                         }
 221                 }
 222
 223                 override protected double RelevancyMultiplier (Hit hit)
 224                 {
 225                         return HalfLifeMultiplierFromProperty (hit, 0.25,
 226                                                                "fixme:endtime", "fixme:starttime");
 227                 }
 228
 229                 override public string GetSnippet (string[] query_terms, Hit hit)
 230                 {
 231                         // FIXME: This does the wrong thing for old-style logs.
 232                         string file = hit ["fixme:file"];
 233                         ICollection logs = KopeteLog.ScanLog (new FileInfo (file));
 234                         IEnumerator iter = logs.GetEnumerator ();
 235                         ImLog log = null;
 236                         if (iter.MoveNext ())
 237                                 log = iter.Current as ImLog;
 238                         if (log == null)
 239                                 return null;
 240
 241                         string result = "";
 242
 243                         // FIXME: This is very lame, and doesn't do the
 244                         // right thing w/ stemming, word boundaries, etc.
 245                         foreach (ImLog.Utterance utt in log.Utterances) {
 246                                 string text = utt.Text;
 247                                 string who = utt.Who;
 248
 249                                 string snippet = SnippetFu.GetSnippet (query_terms, new StringReader (text));
 250
 251                                 if (snippet == null || snippet == "")
 252                                         continue;
 253
 254                                 result += String.Format ("{0}: {1} ", who, snippet);
 255
 256                                 if (result.Length > 300)
 257                                         break;
 258                         }
 259
 260                         if (result != "")
 261                                 return result;
 262                         else
 263                                 return log.Snippet;
 264                 }
 265
 266                 override protected bool HitFilter (Hit hit)
 267                 {
 268                         ImBuddy buddy = list.Search (hit ["fixme:speakingto"]);
 269
 270                         if (buddy != null) {
 271                                 if (buddy.Alias != "")
 272                                         hit ["fixme:speakingto_alias"] = buddy.Alias;
 273
 274                                 // FIXME: Icons?
 275                         }
 276
 277                         return true;
 278                 }
 279         }
 280 }