Click here to Skip to main content
15,884,298 members
Articles / Programming Languages / C#
Article

UploadFileEx: C#'s WebClient.UploadFile with more functionality

Rate me:
Please Sign up or sign in to vote.
4.81/5 (33 votes)
19 Oct 20041 min read 434.2K   4.6K   87   81
UploadFile hides some of the things you might need to get your Windows client simulating forms with file input fields. UploadFileEx gives you more control where you need it!

Introduction

Okay, so you like the idea behind WebClient's UploadFile function, but you can't get it to do all the things you want? That's were I was at a week ago. This is what I learned in the past week. UploadFile seems good enough on the surface but you can run into some tricky things fast, like if you have some cookies to manage or you want to specify the content type, or change the name of the file input in the form? Well, this function will take care of those problems and should make simulating a web form with input type=file as easy as pi, er.. pie. Under the hood is a HttpWebRequest version of UploadFile that you could use to add additional functionality.

For example...

You would like to simulate this web form from your C# application:

HTML
<form action ="http://localhost/test.php" method = POST>
<input type = text name = uname>
<input type = password name =passwd>
<input type = FILE name = uploadfile>
<input type=submit>
</form>

You could run UploadFileEx like this:

C#
CookieContainer cookies = new CookieContainer();
//add or use cookies
NameValueCollection querystring = new NameValueCollection();
querystring["uname"]="uname";
querystring["passwd"]="snake3";
string uploadfile;// set to file to upload
uploadfile = "c:\\test.jpg";

//everything except upload file and url can be left blank if needed
string outdata = UploadFileEx(uploadfile, 
     "http://localhost/test.php","uploadfile", "image/pjpeg", 
     querystring,cookies);

So on to the code...

So, this is UploadFileEx:

C#
public static string UploadFileEx( string uploadfile, string url, 
    string fileFormName, string contenttype,NameValueCollection querystring, 
    CookieContainer cookies)
{
    if( (fileFormName== null) ||
        (fileFormName.Length ==0))
    {
        fileFormName = "file";
    }

    if( (contenttype== null) ||
        (contenttype.Length ==0))
    {
        contenttype = "application/octet-stream";
    }


    string postdata;
    postdata = "?";
    if (querystring!=null)
    {
        foreach(string key in querystring.Keys)
        {
            postdata+= key +"=" + querystring.Get(key)+"&";
        }
    }
    Uri uri = new Uri(url+postdata);


    string boundary = "----------" + DateTime.Now.Ticks.ToString("x");
    HttpWebRequest webrequest = (HttpWebRequest)WebRequest.Create(uri);
    webrequest.CookieContainer = cookies;
    webrequest.ContentType = "multipart/form-data; boundary=" + boundary;
    webrequest.Method = "POST";


    // Build up the post message header
    StringBuilder sb = new StringBuilder();
    sb.Append("--");
    sb.Append(boundary);
    sb.Append("\r\n");
    sb.Append("Content-Disposition: form-data; name=\"");
    sb.Append(fileFormName);
    sb.Append("\"; filename=\"");
    sb.Append(Path.GetFileName(uploadfile));
    sb.Append("\"");
    sb.Append("\r\n");
    sb.Append("Content-Type: ");
    sb.Append(contenttype);
    sb.Append("\r\n");
    sb.Append("\r\n");            

    string postHeader = sb.ToString();
    byte[] postHeaderBytes = Encoding.UTF8.GetBytes(postHeader);

    // Build the trailing boundary string as a byte array
    // ensuring the boundary appears on a line by itself
    byte[] boundaryBytes = 
           Encoding.ASCII.GetBytes("\r\n--" + boundary + "\r\n");

    FileStream fileStream = new FileStream(uploadfile, 
                                FileMode.Open, FileAccess.Read);
    long length = postHeaderBytes.Length + fileStream.Length + 
                                           boundaryBytes.Length;
    webrequest.ContentLength = length;

    Stream requestStream = webrequest.GetRequestStream();

    // Write out our post header
    requestStream.Write(postHeaderBytes, 0, postHeaderBytes.Length);

    // Write out the file contents
    byte[] buffer = new Byte[checked((uint)Math.Min(4096, 
                             (int)fileStream.Length))];
    int bytesRead = 0;
    while ( (bytesRead = fileStream.Read(buffer, 0, buffer.Length)) != 0 )
        requestStream.Write(buffer, 0, bytesRead);

    // Write out the trailing boundary
    requestStream.Write(boundaryBytes, 0, boundaryBytes.Length);
    WebResponse responce = webrequest.GetResponse();
    Stream s = responce.GetResponseStream();
    StreamReader sr = new StreamReader(s);

    return sr.ReadToEnd();
}

This might help too..

You can handle the post in various ways but this is the PHP file I wrote to test:

PHP
<?php

print_r($_REQUEST);

$uploadDir = '%SOMEPATH';
$uploadFile = $uploadDir . $_FILES['userfile']['name'];
print "<PRE>";
if (move_uploaded_file($_FILES['userfile']['tmp_name'], $uploadFile))
{
    print "File is valid, and was successfully uploaded. ";
}
else
{
    print "Possible file upload attack!  Here's some debugging info:\n";
    print_r($_FILES);
}
print "</PRE>";
?>

Credits...

I found most of this out by trial and error searching the web. One major source of this information was this article.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


Written By
United States United States
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
GeneralRe: WebClient with cookies now possible. Pin
u7pro2-Mar-07 4:33
u7pro2-Mar-07 4:33 
GeneralRe: WebClient with cookies now possible. Pin
katokay2-Mar-07 5:28
katokay2-Mar-07 5:28 
QuestionRe: WebClient with cookies now possible. Pin
NickHD22-Apr-07 2:28
NickHD22-Apr-07 2:28 
QuestionRe: WebClient with cookies now possible. Pin
Nooklez18-Jun-07 23:37
Nooklez18-Jun-07 23:37 
AnswerRe: WebClient with cookies now possible. (Wrong) Pin
Siddhaant Infolines11-Jul-07 20:46
Siddhaant Infolines11-Jul-07 20:46 
GeneralPOST data Pin
morecraf1-Mar-06 4:21
morecraf1-Mar-06 4:21 
GeneralRe: POST data Pin
satyajeeth20-Feb-07 1:01
satyajeeth20-Feb-07 1:01 
GeneralClosing Boundary Error Pin
Nick Lucas16-Dec-05 5:02
Nick Lucas16-Dec-05 5:02 
The line:
byte[] boundaryBytes =
Encoding.ASCII.GetBytes("\r\n--" + boundary + "\r\n");

Should be:
byte[] boundaryBytes =
Encoding.ASCII.GetBytes("\r\n--" + boundary + "--\r\n")

It needs the two extra hyphens at the end otherwise you'll get an error 400 returned from the server.
I hope this helps someone as it nearly drove me insane !
GeneralRe: Closing Boundary Error Pin
Kartik Ganesan29-Nov-06 11:18
Kartik Ganesan29-Nov-06 11:18 
GeneralProxy problems Pin
KriG23-Nov-05 2:02
KriG23-Nov-05 2:02 
Generaldon't know how to resolve this error Pin
warenbe10-Nov-05 12:57
warenbe10-Nov-05 12:57 
GeneralRe: don't know how to resolve this error Pin
interesting.com.au27-Jul-06 20:14
interesting.com.au27-Jul-06 20:14 
GeneralRe: don't know how to resolve this error Pin
warenbe28-Jul-06 0:22
warenbe28-Jul-06 0:22 
GeneralRe: don't know how to resolve this error Pin
Member 109448629-Apr-15 22:14
Member 109448629-Apr-15 22:14 
GeneralRe: don't know how to resolve this error Pin
Kin Tutnik17-Nov-06 19:19
Kin Tutnik17-Nov-06 19:19 
Questioncan we asp file instead of php file Pin
payoshini23-May-05 19:45
payoshini23-May-05 19:45 
QuestionServer response indication? Pin
Anonymous16-May-05 7:27
Anonymous16-May-05 7:27 
GeneralProgress Pin
Mr Smiley27-Apr-05 15:33
Mr Smiley27-Apr-05 15:33 
GeneralRe: Progress Pin
madmik328-Apr-05 4:03
madmik328-Apr-05 4:03 
GeneralRe: Progress Pin
AndreRovani24-May-05 4:39
AndreRovani24-May-05 4:39 
GeneralRe: Progress Pin
alpha_krone16-Jul-07 19:45
alpha_krone16-Jul-07 19:45 
GeneralGot Error 401.1 from the server. Pin
A.Neves21-Apr-05 8:35
A.Neves21-Apr-05 8:35 
GeneralVB.Net revision Pin
sandeegk7714-Apr-05 12:49
sandeegk7714-Apr-05 12:49 
GeneralWhy I cant execute this using php Pin
egoing11-Apr-05 1:37
egoing11-Apr-05 1:37 
GeneralPocketPC Version Pin
ChRoNoN8-Mar-05 6:33
ChRoNoN8-Mar-05 6:33 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.