BeagleClient/Query.cs

   1 //
   2 // Query.cs
   3 //
   4 // Copyright (C) 2004-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
  28 using System;
  29 using System.IO;
  30 using System.Collections;
  31 using System.Text;
  32 using System.Xml.Serialization;
  33
  34 using Beagle.Util;
  35
  36 namespace Beagle {
  37
  38         [Flags]
  39         public enum QueryDomain {
  40                 Local        = 1,
  41                 System       = 2,
  42                 Neighborhood = 4,
  43                 Global       = 8
  44         }
  45
  46         public class Query : RequestMessage {
  47
  48                 // FIXME: This is a good default when on an airplane.
  49                 private Beagle.QueryDomain domainFlags = QueryDomain.Local | QueryDomain.System;
  50
  51                 private ArrayList parts = new ArrayList ();
  52                 private ArrayList mimeTypes = new ArrayList ();
  53                 private ArrayList hitTypes = new ArrayList ();
  54                 private ArrayList searchSources = new ArrayList ();
  55
  56                 private ArrayList exact_text = null;
  57                 private ArrayList stemmed_text = null;
  58
  59                 private QueryPart_Or mime_type_part = null;
  60                 private QueryPart_Or hit_type_part = null;
  61                 private QueryPart_Or source_part = null;
  62
  63                 private bool is_index_listener = false;
  64
  65                 // Events to make things nicer to clients
  66                 public delegate void HitsAdded (HitsAddedResponse response);
  67                 public event HitsAdded HitsAddedEvent;
  68
  69                 public delegate void HitsSubtracted (HitsSubtractedResponse response);
  70                 public event HitsSubtracted HitsSubtractedEvent;
  71
  72                 public delegate void Finished (FinishedResponse response);
  73                 public event Finished FinishedEvent;
  74
  75                 public Query () : base (true)
  76                 {
  77                         this.RegisterAsyncResponseHandler (typeof (HitsAddedResponse), OnHitsAdded);
  78                         this.RegisterAsyncResponseHandler (typeof (HitsSubtractedResponse), OnHitsSubtracted);
  79                         this.RegisterAsyncResponseHandler (typeof (FinishedResponse), OnFinished);
  80                         this.RegisterAsyncResponseHandler (typeof (ErrorResponse), OnError);
  81                         this.RegisterAsyncResponseHandler (typeof (SearchTermResponse), OnSearchTerms);
  82                 }
  83
  84                 public Query (string str) : this ()
  85                 {
  86                         AddText (str);
  87                 }
  88
  89                 ///////////////////////////////////////////////////////////////
  90
  91                 private void OnHitsAdded (ResponseMessage r)
  92                 {
  93                         HitsAddedResponse response = (HitsAddedResponse) r;
  94
  95                         if (this.HitsAddedEvent != null)
  96                                 this.HitsAddedEvent (response);
  97                 }
  98
  99                 private void OnHitsSubtracted (ResponseMessage r)
 100                 {
 101                         HitsSubtractedResponse response = (HitsSubtractedResponse) r;
 102
 103                         if (this.HitsSubtractedEvent != null)
 104                                 this.HitsSubtractedEvent (response);
 105                 }
 106
 107                 private void OnFinished (ResponseMessage r)
 108                 {
 109                         FinishedResponse response = (FinishedResponse) r;
 110
 111                         if (this.FinishedEvent != null)
 112                                 this.FinishedEvent (response);
 113                 }
 114
 115                 private void OnError (ResponseMessage r)
 116                 {
 117                         ErrorResponse response = (ErrorResponse) r;
 118
 119                         throw new ResponseMessageException (response);
 120                 }
 121
 122                 private void OnSearchTerms (ResponseMessage r)
 123                 {
 124                         SearchTermResponse response = (SearchTermResponse) r;
 125                         ProcessSearchTermResponse (response);
 126                 }
 127
 128                 ///////////////////////////////////////////////////////////////
 129
 130                 // This is exposed for the benefit of QueryDriver.DoQueryLocal
 131                 public void ProcessSearchTermResponse (SearchTermResponse response)
 132                 {
 133                         exact_text = response.ExactText;
 134                         stemmed_text = response.StemmedText;
 135                 }
 136
 137                 ///////////////////////////////////////////////////////////////
 138
 139                 // Warning: For the moment, the daemon is allowed to IGNORE
 140                 // index listener queries at its discretion... so don't assume
 141                 // that they will work for you!  Listener queries should only be
 142                 // used for debugging and testing.
 143
 144                 public bool IsIndexListener {
 145                         set { is_index_listener = value; }
 146                         get { return is_index_listener; }
 147                 }
 148
 149                 ///////////////////////////////////////////////////////////////
 150
 151                 public void ClearParts ()
 152                 {
 153                         if (parts != null)
 154                                 parts.Clear ();
 155                 }
 156
 157                 public void AddPart (QueryPart part)
 158                 {
 159                         if (part != null)
 160                                 parts.Add (part);
 161                 }
 162
 163                 // This is a human-entered query string that will be parsed in
 164                 // the daemon.
 165                 public void AddText (string str)
 166                 {
 167                         QueryPart_Human part;
 168                         part = new QueryPart_Human ();
 169                         part.QueryString = str;
 170                         AddPart (part);
 171                 }
 172
 173                 [XmlArrayItem (ElementName="Part", Type=typeof (QueryPart))]
 174                 [XmlArray (ElementName="Parts")]
 175                 public ArrayList Parts {
 176                         get { return parts; }
 177                 }
 178
 179                 [XmlIgnore]
 180                 public ICollection Text {
 181                         get { return exact_text; }
 182                 }
 183
 184                 [XmlIgnore]
 185                 public string QuotedText {
 186                         get {
 187                                 StringBuilder builder = new StringBuilder ();
 188                                 foreach (string text in Text) {
 189                                         string text_cooked = text;
 190                                         if (builder.Length > 0)
 191                                                 builder.Append (' ');
 192                                         bool contains_space = (text.IndexOf (' ') != -1);
 193                                         if (contains_space) {
 194                                                 text_cooked = text.Replace ("\"", "\\\"");
 195                                                 builder.Append ('"');
 196                                         }
 197                                         builder.Append (text_cooked);
 198                                         if (contains_space)
 199                                                 builder.Append ('"');
 200                                 }
 201                                 return builder.ToString ();
 202                         }
 203                 }
 204
 205                 [XmlIgnore]
 206                 public ICollection StemmedText {
 207                         get { return stemmed_text; }
 208                 }
 209
 210                 ///////////////////////////////////////////////////////////////
 211
 212                 // This API is DEPRECATED.
 213                 // The mime type is now stored in the beagle:MimeType property.
 214                 // To restrict on mime type, just do a normal property query.
 215
 216                 public void AddMimeType (string str)
 217                 {
 218                         mimeTypes.Add (str);
 219
 220                         if (mime_type_part == null) {
 221                                 mime_type_part = new QueryPart_Or ();
 222                                 AddPart (mime_type_part);
 223                         }
 224
 225                         // Create a part for this mime type.
 226                         QueryPart_Property part;
 227                         part = new QueryPart_Property ();
 228                         part.Type = PropertyType.Keyword;
 229                         part.Key = "beagle:MimeType";
 230                         part.Value = str;
 231                         mime_type_part.Add (part);
 232                 }
 233
 234                 public bool AllowsMimeType (string str)
 235                 {
 236                         if (mimeTypes.Count == 0)
 237                                 return true;
 238                         foreach (string mt in mimeTypes)
 239                                 if (str == mt)
 240                                         return true;
 241                         return false;
 242                 }
 243
 244                 [XmlArrayItem (ElementName="MimeType",
 245                                Type=typeof (string))]
 246                 [XmlArray (ElementName="MimeTypes")]
 247                 public ArrayList MimeTypes {
 248                         get { return mimeTypes; }
 249                 }
 250
 251                 public bool HasMimeTypes {
 252                         get { return mimeTypes.Count > 0; }
 253                 }
 254
 255                 ///////////////////////////////////////////////////////////////
 256
 257                 // This API is DEPRECATED.
 258                 // The mime type is now stored in the beagle:HitType property.
 259                 // To restrict on type, just do a normal property query.
 260
 261                 public void AddHitType (string str)
 262                 {
 263                         hitTypes.Add (str);
 264
 265                         if (hit_type_part == null) {
 266                                 hit_type_part = new QueryPart_Or ();
 267                                 AddPart (hit_type_part);
 268                         }
 269
 270                         // Add a part for this hit type.
 271                         QueryPart_Property part;
 272                         part = new QueryPart_Property ();
 273                         part.Type = PropertyType.Keyword;
 274                         part.Key = "beagle:HitType";
 275                         part.Value = str;
 276                         hit_type_part.Add (part);
 277                 }
 278
 279                 public bool AllowsHitType (string str)
 280                 {
 281                         if (hitTypes.Count == 0)
 282                                 return true;
 283                         foreach (string ht in hitTypes)
 284                                 if (str == ht)
 285                                         return true;
 286                         return false;
 287                 }
 288
 289                 [XmlArrayItem (ElementName="HitType",
 290                                Type=typeof(string))]
 291                 [XmlArray (ElementName="HitTypes")]
 292                 public ArrayList HitTypes {
 293                         get { return hitTypes; }
 294                 }
 295
 296                 [XmlIgnore]
 297                 public bool HasHitTypes {
 298                         get { return hitTypes.Count > 0; }
 299                 }
 300
 301                 ///////////////////////////////////////////////////////////////
 302
 303                 // This API is DEPRECATED.
 304                 // The source is now stored in the beagle:Source property.
 305                 // To restrict on source, just do a normal property query.
 306
 307                 public void AddSource (string str)
 308                 {
 309                         searchSources.Add (str);
 310
 311                         if (source_part == null) {
 312                                 source_part = new QueryPart_Or ();
 313                                 AddPart (source_part);
 314                         }
 315
 316                         // Add a part for this source type.
 317                         QueryPart_Property part;
 318                         part = new QueryPart_Property ();
 319                         part.Type = PropertyType.Keyword;
 320                         part.Key = "beagle:Source";
 321                         part.Value = str;
 322                         source_part.Add (part);
 323                 }
 324
 325
 326                 public bool AllowsSource (string str)
 327                 {
 328                         if (searchSources.Count == 0)
 329                                 return true;
 330                         foreach (string ss in searchSources)
 331                                 if (str == ss)
 332                                         return true;
 333                         return false;
 334                 }
 335
 336                 [XmlArrayItem (ElementName="Source",
 337                                Type=typeof (string))]
 338                 [XmlArray (ElementName="Sources")]
 339                 public ArrayList Sources {
 340                         get { return searchSources; }
 341                 }
 342
 343                 [XmlIgnore]
 344                 public bool HasSources {
 345                         get { return searchSources.Count > 0; }
 346                 }
 347
 348                 ///////////////////////////////////////////////////////////////
 349
 350                 public QueryDomain QueryDomain {
 351                         get { return domainFlags; }
 352                         set { domainFlags = value; }
 353                 }
 354
 355                 public void AddDomain (Beagle.QueryDomain d)
 356                 {
 357                         domainFlags |= d;
 358                 }
 359
 360                 public void RemoveDomain (Beagle.QueryDomain d)
 361                 {
 362                         domainFlags &= ~d;
 363                 }
 364
 365                 public bool AllowsDomain (Beagle.QueryDomain d)
 366                 {
 367                         return (domainFlags & d) != 0;
 368                 }
 369
 370                 ///////////////////////////////////////////////////////////////
 371
 372                 private int max_hits = 100;
 373                 public int MaxHits {
 374                         get { return max_hits; }
 375                         set { max_hits = value; }
 376                 }
 377
 378                 ///////////////////////////////////////////////////////////////
 379
 380                 [XmlIgnore]
 381                 public bool IsEmpty {
 382                         get { return parts.Count == 0
 383                                       && mimeTypes.Count == 0
 384                                       && searchSources.Count == 0; }
 385                 }
 386
 387                 public override string ToString ()
 388                 {
 389                         StringBuilder sb = new StringBuilder ();
 390
 391                         foreach (QueryPart p in parts)
 392                                 sb.Append (p.ToString () + "\n");
 393
 394                         return sb.ToString ();
 395                 }
 396         }
 397 }