mcs/class/System/System.Net/FileWebRequest.cs

   1 //
   2 // System.Net.FileWebRequest
   3 //
   4 // Author:
   5 //   Lawrence Pit (loz@cable.a2000.nl)
   6 //
   7
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System;
  30 using System.Collections;
  31 using System.IO;
  32 using System.Runtime.Serialization;
  33 using System.Runtime.Remoting.Messaging;
  34 using System.Threading;
  35
  36 namespace System.Net
  37 {
  38         [Serializable]
  39         public class FileWebRequest : WebRequest, ISerializable
  40         {
  41                 private Uri uri;
  42                 private WebHeaderCollection webHeaders;
  43
  44                 private ICredentials credentials;
  45                 private string connectionGroup;
  46                 private string method = "GET";
  47                 private int timeout = 100000;
  48
  49                 private Stream requestStream;
  50                 private FileWebResponse webResponse;
  51                 private AutoResetEvent requestEndEvent;
  52                 private bool requesting;
  53                 private bool asyncResponding;
  54
  55                 // Constructors
  56
  57                 internal FileWebRequest (Uri uri)
  58                 {
  59                         this.uri = uri;
  60                         this.webHeaders = new WebHeaderCollection ();
  61                 }
  62
  63                 protected FileWebRequest (SerializationInfo serializationInfo, StreamingContext streamingContext)
  64                 {
  65                         SerializationInfo info = serializationInfo;
  66
  67                         method = info.GetString ("method");
  68                         uri = (Uri) info.GetValue ("uri", typeof (Uri));
  69                         timeout = info.GetInt32 ("timeout");
  70                         connectionGroup = info.GetString ("connectionGroup");
  71                         webHeaders = (WebHeaderCollection) info.GetValue ("webHeaders", typeof (WebHeaderCollection));
  72                 }
  73
  74                 // Properties
  75
  76                 // currently not used according to spec
  77                 public override string ConnectionGroupName {
  78                         get { return connectionGroup; }
  79                         set { connectionGroup = value; }
  80                 }
  81
  82                 public override long ContentLength {
  83                         get {
  84                                 try {
  85                                         return Int64.Parse (webHeaders ["Content-Length"]);
  86                                 } catch (Exception) {
  87                                         return 0;
  88                                 }
  89                         }
  90                         set {
  91                                 if (value < 0)
  92                                         throw new ArgumentException ("value");
  93                                 webHeaders ["Content-Length"] = Convert.ToString (value);
  94                         }
  95                 }
  96
  97                 public override string ContentType {
  98                         get { return webHeaders ["Content-Type"]; }
  99                         set { webHeaders ["Content-Type"] = value; }
 100                 }
 101
 102                 public override ICredentials Credentials {
 103                         get { return credentials; }
 104                         set { credentials = value; }
 105                 }
 106
 107                 public override WebHeaderCollection Headers {
 108                         get { return webHeaders; }
 109                 }
 110
 111                 // currently not used according to spec
 112                 public override string Method {
 113                         get { return this.method; }
 114                         set { this.method = value; }
 115                 }
 116
 117                 // currently not used according to spec
 118                 public override bool PreAuthenticate {
 119                         get { throw new NotSupportedException (); }
 120                         set { throw new NotSupportedException (); }
 121                 }
 122
 123                 // currently not used according to spec
 124                 public override IWebProxy Proxy {
 125                         get { throw new NotSupportedException (); }
 126                         set { throw new NotSupportedException (); }
 127                 }
 128
 129                 public override Uri RequestUri {
 130                         get { return this.uri; }
 131                 }
 132
 133                 public override int Timeout {
 134                         get { return timeout; }
 135                         set {
 136                                 if (value < 0)
 137                                         throw new ArgumentException ("value");
 138                                 timeout = value;
 139                         }
 140                 }
 141
 142                 // Methods
 143
 144                 private delegate Stream GetRequestStreamCallback ();
 145                 private delegate WebResponse GetResponseCallback ();
 146
 147                 public override IAsyncResult BeginGetRequestStream (AsyncCallback callback, object state)
 148                 {
 149                         if (method == null || (!method.Equals ("PUT") && !method.Equals ("POST")))
 150                                 throw new ProtocolViolationException ("Cannot send file when method is: " + this.method + ". Method must be PUT.");
 151                         // workaround for bug 24943
 152                         Exception e = null;
 153                         lock (this) {
 154                                 if (asyncResponding || webResponse != null)
 155                                         e = new InvalidOperationException ("This operation cannot be performed after the request has been submitted.");
 156                                 else if (requesting)
 157                                         e = new InvalidOperationException ("Cannot re-call start of asynchronous method while a previous call is still in progress.");
 158                                 else
 159                                         requesting = true;
 160                         }
 161                         if (e != null)
 162                                 throw e;
 163                         /*
 164                         lock (this) {
 165                                 if (asyncResponding || webResponse != null)
 166                                         throw new InvalidOperationException ("This operation cannot be performed after the request has been submitted.");
 167                                 if (requesting)
 168                                         throw new InvalidOperationException ("Cannot re-call start of asynchronous method while a previous call is still in progress.");
 169                                 requesting = true;
 170                         }
 171                         */
 172                         GetRequestStreamCallback c = new GetRequestStreamCallback (this.GetRequestStreamInternal);
 173                         return c.BeginInvoke (callback, state);
 174                 }
 175
 176                 public override Stream EndGetRequestStream (IAsyncResult asyncResult)
 177                 {
 178                         if (asyncResult == null)
 179                                 throw new ArgumentNullException ("asyncResult");
 180                         if (!asyncResult.IsCompleted)
 181                                 asyncResult.AsyncWaitHandle.WaitOne ();
 182                         AsyncResult async = (AsyncResult) asyncResult;
 183                         GetRequestStreamCallback cb = (GetRequestStreamCallback) async.AsyncDelegate;
 184                         return cb.EndInvoke (asyncResult);
 185                 }
 186
 187                 public override Stream GetRequestStream()
 188                 {
 189                         IAsyncResult asyncResult = BeginGetRequestStream (null, null);
 190                         if (!(asyncResult.AsyncWaitHandle.WaitOne (timeout, false))) {
 191                                 throw new WebException("The request timed out", WebExceptionStatus.Timeout);
 192                         }
 193                         return EndGetRequestStream (asyncResult);
 194                 }
 195
 196                 internal Stream GetRequestStreamInternal ()
 197                 {
 198                         this.requestStream = new FileWebStream (
 199                                                 this,
 200                                                 FileMode.CreateNew,
 201                                                 FileAccess.Write,
 202                                                 FileShare.Read);
 203                         return this.requestStream;
 204                 }
 205
 206                 public override IAsyncResult BeginGetResponse (AsyncCallback callback, object state)
 207                 {
 208                         // workaround for bug 24943
 209                         Exception e = null;
 210                         lock (this) {
 211                                 if (asyncResponding)
 212                                         e = new InvalidOperationException ("Cannot re-call start of asynchronous method while a previous call is still in progress.");
 213                                 else
 214                                         asyncResponding = true;
 215                         }
 216                         if (e != null)
 217                                 throw e;
 218                         /*
 219                         lock (this) {
 220                                 if (asyncResponding)
 221                                         throw new InvalidOperationException ("Cannot re-call start of asynchronous method while a previous call is still in progress.");
 222                                 asyncResponding = true;
 223                         }
 224                         */
 225                         GetResponseCallback c = new GetResponseCallback (this.GetResponseInternal);
 226                         return c.BeginInvoke (callback, state);
 227                 }
 228
 229                 public override WebResponse EndGetResponse (IAsyncResult asyncResult)
 230                 {
 231                         if (asyncResult == null)
 232                                 throw new ArgumentNullException ("asyncResult");
 233                         if (!asyncResult.IsCompleted)
 234                                 asyncResult.AsyncWaitHandle.WaitOne ();
 235                         AsyncResult async = (AsyncResult) asyncResult;
 236                         GetResponseCallback cb = (GetResponseCallback) async.AsyncDelegate;
 237                         WebResponse webResponse = cb.EndInvoke(asyncResult);
 238                         asyncResponding = false;
 239                         return webResponse;
 240                 }
 241
 242                 public override WebResponse GetResponse ()
 243                 {
 244                         IAsyncResult asyncResult = BeginGetResponse (null, null);
 245                         if (!(asyncResult.AsyncWaitHandle.WaitOne (timeout, false))) {
 246                                 throw new WebException("The request timed out", WebExceptionStatus.Timeout);
 247                         }
 248                         return EndGetResponse (asyncResult);
 249                 }
 250
 251                 WebResponse GetResponseInternal ()
 252                 {
 253                         if (webResponse != null)
 254                                 return webResponse;
 255                         lock (this) {
 256                                 if (requesting) {
 257                                         requestEndEvent = new AutoResetEvent (false);
 258                                 }
 259                         }
 260                         if (requestEndEvent != null) {
 261                                 requestEndEvent.WaitOne ();
 262                         }
 263                         FileStream fileStream = new FileWebStream (
 264                                                         this,
 265                                                         FileMode.Open,
 266                                                         FileAccess.Read,
 267                                                         FileShare.Read);
 268                         this.webResponse = new FileWebResponse (this.uri, fileStream);
 269                         return (WebResponse) this.webResponse;
 270                 }
 271
 272                 void ISerializable.GetObjectData (SerializationInfo serializationInfo, StreamingContext streamingContext)
 273                 {
 274                         SerializationInfo info = serializationInfo;
 275
 276                         info.AddValue ("method", method);
 277                         info.AddValue ("uri", uri, typeof (Uri));
 278                         info.AddValue ("timeout", timeout);
 279                         info.AddValue ("connectionGroup", connectionGroup);
 280                         info.AddValue ("webHeaders", webHeaders, typeof (WebHeaderCollection));
 281                 }
 282
 283                 internal void Close ()
 284                 {
 285                         // already done in class below
 286                         // if (requestStream != null) {
 287                         //      requestStream.Close ();
 288                         // }
 289
 290                         lock (this) {
 291                                 requesting = false;
 292                                 if (requestEndEvent != null)
 293                                         requestEndEvent.Set ();
 294                                 // requestEndEvent = null;
 295                         }
 296                 }
 297
 298                 // to catch the Close called on the FileStream
 299                 internal class FileWebStream : FileStream
 300                 {
 301                         FileWebRequest webRequest;
 302
 303                         internal FileWebStream (FileWebRequest webRequest,
 304                                                 FileMode mode,
 305                                                 FileAccess access,
 306                                                 FileShare share)
 307                                 : base (webRequest.RequestUri.LocalPath,
 308                                         mode, access, share)
 309                         {
 310                                 this.webRequest = webRequest;
 311                         }
 312
 313                         public override void Close()
 314                         {
 315                                 base.Close ();
 316                                 FileWebRequest req = webRequest;
 317                                 webRequest = null;
 318                                 if (req != null)
 319                                         req.Close ();
 320                         }
 321                 }
 322         }
 323 }