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