BeagleClient/Indexable.cs

   1 //
   2 // Indexable.cs
   3 //
   4 // Copyright (C) 2004 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.Collections;
  30 using System.IO;
  31 using System.Text;
  32 using System.Xml;
  33 using System.Xml.Serialization;
  34 using Beagle.Util;
  35
  36 namespace Beagle {
  37
  38         public class Indexable : Versioned {
  39
  40                 // The URI of the item being indexed.
  41                 private Uri uri = null;
  42
  43                 // The URI of the contents to index
  44                 private Uri contentUri = null;
  45
  46                 // The URI of the hot contents to index
  47                 private Uri hotContentUri = null;
  48
  49                 // Whether the content should be deleted after indexing
  50                 private bool deleteContent = false;
  51
  52                 // File, WebLink, MailMessage, IMLog, etc.
  53                 private String type = null;
  54
  55                 // If applicable, otherwise set to null.
  56                 private String mimeType = null;
  57
  58                 // List of Property objects
  59                 private ArrayList properties = new ArrayList ();
  60
  61                 // A stream of the content to index
  62                 private TextReader textReader;
  63
  64                 // A stream of the hot content to index
  65                 private TextReader hotTextReader;
  66
  67                 //////////////////////////
  68
  69                 static private XmlSerializer our_serializer;
  70
  71                 static Indexable ()
  72                 {
  73                         our_serializer = new XmlSerializer (typeof (Indexable));
  74                 }
  75
  76                 //////////////////////////
  77
  78                 public Indexable (Uri _uri) {
  79                         uri = _uri;
  80
  81                         type = "File";
  82                 }
  83
  84                 public Indexable () {
  85                         // Only used when reading from xml
  86                 }
  87
  88                 public static Indexable NewFromXml (string xml)
  89                 {
  90                         StringReader reader = new StringReader (xml);
  91                         return (Indexable) our_serializer.Deserialize (reader);
  92                 }
  93
  94                 //////////////////////////
  95
  96                 // Use Build to do any set-up that you want to defer until
  97                 // immediately before indexing.
  98                 public virtual void Build ()
  99                 {
 100
 101                 }
 102
 103                 //////////////////////////
 104
 105                 [XmlIgnore]
 106                 public Uri Uri {
 107                         get { return uri; }
 108                         set { uri = value; }
 109                 }
 110
 111                 [XmlAttribute ("Uri")]
 112                 public string UriString {
 113                         get { return UriFu.UriToSerializableString (uri); }
 114                         set { uri = UriFu.UriStringToUri (value); }
 115                 }
 116
 117                 [XmlIgnore]
 118                 public Uri ContentUri {
 119                         get { return contentUri != null ? contentUri : Uri; }
 120                         set { contentUri = value; }
 121                 }
 122
 123                 [XmlAttribute ("ContentUri")]
 124                 public string ContentUriString {
 125                         get { return UriFu.UriToSerializableString (ContentUri); }
 126                         set { contentUri = UriFu.UriStringToUri (value); }
 127                 }
 128
 129                 [XmlIgnore]
 130                 private Uri HotContentUri {
 131                         get { return hotContentUri; }
 132                         set { hotContentUri = value; }
 133                 }
 134
 135                 [XmlAttribute ("HotContentUri")]
 136                 public string HotContentUriString {
 137                         get { return HotContentUri != null ? UriFu.UriToSerializableString (HotContentUri) : ""; }
 138                         set { hotContentUri = (value != "") ? new Uri (value) : null; }
 139                 }
 140
 141                 [XmlIgnore]
 142                 public Uri DisplayUri {
 143                         get { return uri.Scheme == "uid" ? ContentUri : Uri; }
 144                 }
 145
 146                 [XmlAttribute]
 147                 public bool DeleteContent {
 148                         get { return deleteContent; }
 149                         set { deleteContent = value; }
 150                 }
 151
 152                 [XmlAttribute]
 153                 public String Type {
 154                         get { return type; }
 155                         set { type = value; }
 156                 }
 157
 158                 [XmlAttribute]
 159                 public String MimeType {
 160                         get { return mimeType; }
 161                         set { mimeType = value; }
 162                 }
 163
 164                 [XmlIgnore]
 165                 public bool IsNonTransient {
 166                         get { return ! DeleteContent && ContentUri.IsFile; }
 167                 }
 168
 169                 //////////////////////////
 170
 171                 private TextReader ReaderFromUri (Uri uri)
 172                 {
 173                         TextReader reader = null;
 174
 175                         if (uri != null && uri.IsFile) {
 176                                 Stream stream = new FileStream (uri.LocalPath,
 177                                                                 FileMode.Open,
 178                                                                 FileAccess.Read,
 179                                                                 FileShare.Read);
 180
 181                                 reader = new StreamReader (stream);
 182
 183                                 // Paranoia: never delete the thing we are actually indexing.
 184                                 if (DeleteContent && uri != Uri)
 185                                         File.Delete (uri.LocalPath);
 186                         }
 187
 188                         return reader;
 189                 }
 190
 191                 public virtual TextReader GetTextReader ()
 192                 {
 193                         if (textReader == null)
 194                                 textReader = ReaderFromUri (ContentUri);
 195
 196                         return textReader;
 197                 }
 198
 199                 public void SetTextReader (TextReader reader)
 200                 {
 201                         textReader = reader;
 202                 }
 203
 204                 public virtual TextReader GetHotTextReader ()
 205                 {
 206                         if (hotTextReader == null)
 207                                 hotTextReader = ReaderFromUri (HotContentUri);
 208                         return hotTextReader;
 209                 }
 210
 211                 public virtual void SetHotTextReader (TextReader reader)
 212                 {
 213                         hotTextReader = reader;
 214                 }
 215
 216                 [XmlArrayItem (ElementName="Property", Type=typeof (Property))]
 217                 public ArrayList Properties {
 218                         get { return properties; }
 219                 }
 220
 221                 public void AddProperty (Property prop) {
 222                         properties.Add (prop);
 223                 }
 224
 225                 //////////////////////////
 226
 227                 private string PropertiesAsString (bool keywords)
 228                 {
 229                         StringBuilder sb = new StringBuilder ();
 230                         foreach (Property prop in Properties) {
 231                                 if (prop.IsSearched
 232                                     && keywords ? prop.IsKeyword : ! prop.IsKeyword) {
 233                                         if (sb.Length > 0)
 234                                                 sb.Append (" ");
 235                                         sb.Append (prop.Value);
 236                                 }
 237                         }
 238                         return sb.ToString ();
 239                 }
 240
 241                 public string TextPropertiesAsString {
 242                         get { return PropertiesAsString (false); }
 243                 }
 244
 245                 public string KeywordPropertiesAsString {
 246                         get { return PropertiesAsString (true); }
 247                 }
 248
 249                 //////////////////////////
 250
 251                 public override string ToString ()
 252                 {
 253                         StringWriter writer = new StringWriter ();
 254                         our_serializer.Serialize (writer, this);
 255                         writer.Close ();
 256                         return writer.ToString ();
 257                 }
 258
 259                 private static Uri TextReaderToTempFileUri (TextReader reader)
 260                 {
 261                         if (reader == null)
 262                                 return null;
 263
 264                         string filename = Path.GetTempFileName ();
 265                         FileStream fileStream = File.OpenWrite (filename);
 266                         BufferedStream bufferedStream = new BufferedStream (fileStream);
 267                         StreamWriter writer = new StreamWriter (bufferedStream);
 268
 269                         const int BUFFER_SIZE = 8192;
 270                         char [] buffer = new char [BUFFER_SIZE];
 271
 272                         int read;
 273                         do {
 274                                 read = reader.Read (buffer, 0, BUFFER_SIZE);
 275                                 if (read > 0)
 276                                         writer.Write (buffer, 0, read);
 277                         } while (read > 0);
 278
 279                         writer.Close ();
 280
 281                         return UriFu.PathToFileUri (filename);
 282                 }
 283
 284                 public void StoreStream () {
 285                         if (textReader != null) {
 286                                 ContentUri = TextReaderToTempFileUri (textReader);
 287                                 DeleteContent = true;
 288                         }
 289
 290                         if (hotTextReader != null) {
 291                                 HotContentUri = TextReaderToTempFileUri (hotTextReader);
 292                                 DeleteContent = true;
 293                         }
 294                 }
 295
 296                 //////////////////////////
 297
 298                 public override int GetHashCode ()
 299                 {
 300                         return (uri != null ? uri.GetHashCode () : 0) ^ type.GetHashCode ();
 301                 }
 302         }
 303 }