beagled/FileSystemQueryable/LuceneNameResolver.cs

   1 //
   2 // LuceneNameResolver.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
  31 using Lucene.Net.Documents;
  32 using Lucene.Net.Index;
  33 using LNS = Lucene.Net.Search;
  34
  35 using Beagle.Daemon;
  36 using Beagle.Util;
  37
  38 namespace Beagle.Daemon.FileSystemQueryable {
  39
  40         //
  41         // This is just a LuceneQueryingDriver with the ability to do the
  42         // special secondary-index-only queries we need to map internal uris
  43         // back to filenames.
  44         //
  45
  46         public class LuceneNameResolver : LuceneQueryingDriver {
  47
  48                 public class NameInfo {
  49                         public Guid   Id;
  50                         public Guid   ParentId;
  51                         public string Name;
  52                         public bool   IsDirectory;
  53                 }
  54
  55                 public LuceneNameResolver (string index_name, int minor_version, bool read_only)
  56                         : base (index_name, minor_version, read_only)
  57                 {
  58
  59                 }
  60
  61                 ////////////////////////////////////////////////////////////////
  62
  63
  64                 private NameInfo DocumentToNameInfo (Document doc)
  65                 {
  66                         NameInfo info;
  67                         info = new NameInfo ();
  68
  69                         string str;
  70                         str = doc.Get ("Uri");
  71                         info.Id = GuidFu.FromUriString (str);
  72
  73                         bool have_name = false;
  74                         bool have_parent_id = false;
  75                         bool have_is_dir = false;
  76
  77                         foreach (Field f in doc.Fields ()) {
  78                                 Property prop;
  79                                 prop = GetPropertyFromDocument (f, doc, false);
  80                                 if (prop == null)
  81                                         continue;
  82
  83                                 switch (prop.Key) {
  84
  85                                 case Property.ExactFilenamePropKey:
  86                                         info.Name = prop.Value;
  87                                         have_name = true;
  88                                         break;
  89
  90                                 case Property.ParentDirUriPropKey:
  91                                         info.ParentId = GuidFu.FromUriString (prop.Value);
  92                                         have_parent_id = true;
  93                                         break;
  94
  95                                 case Property.IsDirectoryPropKey:
  96                                         info.IsDirectory = (prop.Value == "true");
  97                                         have_is_dir = true;
  98                                         break;
  99                                 }
 100
 101                                 if (have_name && have_parent_id && have_is_dir)
 102                                         break;
 103                         }
 104
 105                         return info;
 106                 }
 107
 108                 ////////////////////////////////////////////////////////////////
 109
 110                 // Pull a single record out of the index
 111
 112                 private class SingletonCollector : LNS.HitCollector {
 113
 114                         public int MatchId = -1;
 115
 116                         public override void Collect (int id, float score)
 117                         {
 118                                 if (MatchId != -1)
 119                                         Logger.Log.Error ("Duplicate name found: replacing MatchId {0} with {1}",
 120                                                           MatchId, id);
 121
 122                                 MatchId = id;
 123                         }
 124                 }
 125
 126                 public NameInfo GetNameInfoById (Guid id)
 127                 {
 128                         Uri uri;
 129                         uri = GuidFu.ToUri (id);
 130
 131                         LNS.Query query;
 132                         query = UriQuery ("Uri", uri);
 133
 134                         SingletonCollector collector;
 135                         collector = new SingletonCollector ();
 136
 137                         LNS.IndexSearcher searcher;
 138                         searcher = LuceneCommon.GetSearcher (SecondaryStore);
 139                         searcher.Search (query, null, collector);
 140
 141                         NameInfo info = null;
 142
 143                         if (collector.MatchId != -1) {
 144                                 Document doc;
 145                                 doc = searcher.Doc (collector.MatchId);
 146                                 info = DocumentToNameInfo (doc);
 147                         }
 148
 149                         LuceneCommon.ReleaseSearcher (searcher);
 150
 151                         return info;
 152                 }
 153
 154                 ////////////////////////////////////////////////////////////////
 155
 156                 public Guid GetIdByNameAndParentId (string name, Guid parent_id)
 157                 {
 158                         string parent_uri_str;
 159                         parent_uri_str = GuidFu.ToUriString (parent_id);
 160
 161                         string key1;
 162                         key1 = PropertyToFieldName (PropertyType.Keyword, Property.ParentDirUriPropKey);
 163
 164                         string key2;
 165                         key2 = PropertyToFieldName (PropertyType.Keyword, Property.ExactFilenamePropKey);
 166
 167                         LNS.Query q1;
 168                         q1 = new LNS.TermQuery (new Term (key1, parent_uri_str));
 169
 170                         LNS.Query q2;
 171                         q2 = new LNS.TermQuery (new Term (key2, name.ToLower ()));
 172
 173                         LNS.BooleanQuery query;
 174                         query = new LNS.BooleanQuery ();
 175                         query.Add (q1, true, false);
 176                         query.Add (q2, true, false);
 177
 178                         SingletonCollector collector;
 179                         collector = new SingletonCollector ();
 180
 181                         LNS.IndexSearcher searcher;
 182                         searcher = LuceneCommon.GetSearcher (SecondaryStore);
 183                         searcher.Search (query, null, collector);
 184
 185                         Guid id;
 186                         if (collector.MatchId != -1) {
 187                                 Document doc;
 188                                 doc = searcher.Doc (collector.MatchId);
 189                                 id = GuidFu.FromUriString (doc.Get ("Uri"));
 190                         } else
 191                                 id = Guid.Empty;
 192
 193                         LuceneCommon.ReleaseSearcher (searcher);
 194
 195                         return id;
 196                 }
 197
 198                 ////////////////////////////////////////////////////////////////
 199
 200                 // Pull all of the directories out of the index and cache them
 201
 202                 // Not to be confused with LuceneQueryingDriver.BitArrayHitCollector
 203                 private class BitArrayHitCollector : LNS.HitCollector {
 204
 205                         private BetterBitArray matches;
 206
 207                         public BitArrayHitCollector (BetterBitArray matches)
 208                         {
 209                                 this.matches = matches;
 210                         }
 211
 212                         public override void Collect (int id, float score)
 213                         {
 214                                 matches [id] = true;
 215                         }
 216                 }
 217
 218                 public ICollection GetAllDirectoryNameInfo ()
 219                 {
 220                         // First we assemble a query to find all of the directories.
 221                         string field_name;
 222                         field_name = PropertyToFieldName (PropertyType.Keyword,
 223                                                           Property.IsDirectoryPropKey);
 224
 225                         LNS.Query query;
 226                         query = new LNS.TermQuery (new Term (field_name, "true"));
 227
 228                         // Then we actually run the query
 229                         LNS.IndexSearcher searcher;
 230                         //searcher = new LNS.IndexSearcher (SecondaryStore);
 231                         searcher = LuceneCommon.GetSearcher (SecondaryStore);
 232
 233                         BetterBitArray matches;
 234                         matches = new BetterBitArray (searcher.MaxDoc ());
 235
 236                         BitArrayHitCollector collector;
 237                         collector = new BitArrayHitCollector (matches);
 238
 239                         searcher.Search (query, null, collector);
 240
 241                         // Finally we pull all of the matching documents,
 242                         // convert them to NameInfo, and store them in a list.
 243
 244                         ArrayList match_list = new ArrayList ();
 245                         int i = 0;
 246                         while (i < matches.Count) {
 247
 248                                 i = matches.GetNextTrueIndex (i);
 249                                 if (i >= matches.Count)
 250                                         break;
 251
 252                                 Document doc;
 253                                 doc = searcher.Doc (i);
 254
 255                                 NameInfo info;
 256                                 info = DocumentToNameInfo (doc);
 257
 258                                 match_list.Add (info);
 259
 260                                 ++i;
 261                         }
 262
 263                         LuceneCommon.ReleaseSearcher (searcher);
 264
 265                         return match_list;
 266                 }
 267         }
 268 }