beagled/ThunderbirdQueryable/ThunderbirdQueryable.cs

   1 //
   2 // ThunderbirdQueryable.cs: This is where all the magic begins!
   3 //
   4 // Copyright (C) 2006 Pierre Östlund
   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.IO;
  29 using System.Threading;
  30 using System.Collections;
  31 using System.Text.RegularExpressions;
  32
  33 using Beagle;
  34 using Beagle.Util;
  35
  36 // Register the Thunderbird backend for this assembly.
  37 [assembly: Beagle.Daemon.IQueryableTypes (typeof (Beagle.Daemon.ThunderbirdQueryable.ThunderbirdQueryable))]
  38
  39 namespace Beagle.Daemon.ThunderbirdQueryable {
  40
  41         [QueryableFlavor (Name = "Thunderbird", Domain = QueryDomain.Local, RequireInotify = false)]
  42         public class ThunderbirdQueryable : LuceneQueryable {
  43                 private static DateTime indexing_start;
  44                 private ThunderbirdIndexer indexer;
  45
  46                 public ThunderbirdQueryable () :
  47                         base ("ThunderbirdIndex")
  48                 {
  49                         // Remove one second from the start time to make sure we don't run into any troubles
  50                         indexing_start = DateTime.UtcNow.Subtract (new TimeSpan (0, 0, 1));
  51                         indexer = null;
  52
  53                         GMime.Global.Init ();
  54
  55                         if (Environment.GetEnvironmentVariable ("BEAGLE_THUNDERBIRD_DEBUG") != null) {
  56                                 Thunderbird.Debug = true;
  57                                 Logger.Log.Debug ("Running Thunderbird backend in debug mode");
  58                         }
  59                 }
  60
  61                 public override void Start ()
  62                 {
  63                         base.Start ();
  64                         ExceptionHandlingThread.Start (new ThreadStart (StartWorker));
  65                 }
  66
  67                 private void StartWorker ()
  68                 {
  69                         Logger.Log.Info ("Starting Thunderbird backend");
  70                         Stopwatch watch = new Stopwatch ();
  71                         watch.Start ();
  72
  73                         string root_path = Thunderbird.GetRootPath ();
  74                         if (!Directory.Exists (root_path)) {
  75                                 GLib.Timeout.Add (60000, new GLib.TimeoutHandler (IndexDataCheck));
  76                                 Logger.Log.Info ("No data available for indexing in {0}", root_path);
  77                                 return;
  78                         }
  79
  80                         State = QueryableState.Crawling;
  81                         indexer = new ThunderbirdIndexer (this, Thunderbird.GetProfilePaths (root_path));
  82                         indexer.Crawl ();
  83                         State = QueryableState.Idle;
  84
  85                         watch.Stop ();
  86                         Logger.Log.Info ("Thunderbird backend done in {0}s", watch.ElapsedTime);
  87                 }
  88
  89                 private bool IndexDataCheck ()
  90                 {
  91                         if (!Directory.Exists (Thunderbird.GetRootPath ()))
  92                                 return true;
  93
  94                         StartWorker ();
  95                         return false;
  96                 }
  97
  98                 // We need this in order to perform custom queries to the lucene database
  99                 override protected LuceneQueryingDriver BuildLuceneQueryingDriver (string index_name,
 100                                                                                    int    minor_version,
 101                                                                                    bool   read_only_mode)
 102                 {
 103                         return new LuceneAccess (index_name, minor_version, read_only_mode);
 104                 }
 105
 106                 /////////////////////////////////////////////////////////////////////////////////////
 107
 108                 public Scheduler.Task NewRemoveTaskByDate (DateTime end_date)
 109                 {
 110                         return NewAddTask (new DateIndexableGenerator (Driver, Lucene, end_date));
 111                 }
 112
 113                 // The purpose of this IndexableGenerator is to remove mails older than the
 114                 // specified date (when beagle began to index Thunderbird mails)
 115                 private class DateIndexableGenerator : IIndexableGenerator {
 116                         private LuceneQueryingDriver driver;
 117                         private LuceneAccess lucene;
 118                         private DateTime end_date;
 119
 120                         private Uri[] stored_uris;
 121                         private IEnumerator enumerator;
 122
 123                         public DateIndexableGenerator (LuceneQueryingDriver driver, LuceneAccess lucene, DateTime end_date)
 124                         {
 125                                 this.driver = driver;
 126                                 this.lucene = lucene;
 127                                 this.end_date = end_date;
 128                                 this.stored_uris = null;
 129                         }
 130
 131                         public Indexable GetNextIndexable ()
 132                         {
 133                                 return new Indexable (IndexableType.Remove, (Uri) enumerator.Current);
 134                         }
 135
 136                         public bool HasNextIndexable ()
 137                         {
 138                                 if (stored_uris == null) {
 139                                         stored_uris = driver.PropertyQuery (Property.NewKeyword ("fixme:client", "thunderbird"));
 140                                         enumerator = stored_uris.GetEnumerator ();
 141                                 }
 142
 143                                 do {
 144                                         while (enumerator == null || !enumerator.MoveNext ())
 145                                                 return false;
 146                                 } while (MatchesDate ((enumerator.Current as Uri)));
 147
 148                                 return true;
 149                         }
 150
 151                         private bool MatchesDate (Uri uri)
 152                         {
 153                                 LuceneAccess.StoredInfo info = lucene.GetStoredInfo (uri);
 154
 155                                 try {
 156                                         if (!info.Equals (end_date) && info.LastIndex.CompareTo (end_date) < 0)
 157                                                 return false;
 158                                 } catch {}
 159
 160                                 return true;
 161                         }
 162
 163                         public string StatusName {
 164                                 get {
 165                                         return String.Format ("Removing Thunderbird mails past {0}", end_date.ToString ());
 166                                 }
 167                         }
 168
 169                         public void PostFlushHook () { }
 170                 }
 171
 172                 /////////////////////////////////////////////////////////////////////////////////////
 173
 174                 public LuceneAccess Lucene {
 175                         get { return (LuceneAccess) Driver; }
 176                 }
 177
 178                 public static DateTime IndexingStart {
 179                         get { return indexing_start; }
 180                 }
 181         }
 182
 183 }