Bug 40835 - Unclosed FileInputStream in WebdavResource.putMethod
Summary: Unclosed FileInputStream in WebdavResource.putMethod
Status: RESOLVED FIXED
Alias: None
Product: Slide
Classification: Unclassified
Component: WebDAV client (show other bugs)
Version: 2.1
Hardware: Other other
: P2 normal (vote)
Target Milestone: 2.2
Assignee: Slide Developer List
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-10-27 13:11 UTC by Michael N. Christoff
Modified: 2007-02-11 19:22 UTC (History)
0 users



Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Michael N. Christoff 2006-10-27 13:11:00 UTC
A FileInputStream in the putMethod(String path, File file) method of
WebdavResource is not closed.  On Windows (and any other OS that blocks writing
to open files) this will prevent editing of any file uploaded via this method
until the application that uploaded the file is exited.

See below for the simple fix (one can simply comment-out the old version of the
method and paste-in this one in its entirety).

Cheers!

Michael N. Christoff
dmx_dawg@hotmail.com


    /**
     * Execute the PUT method for the given path.
     *
     * October 22, 2006
     * Fixed error where FileInputStream not closed.
     *
     * @param path the server relative path to put the given file
     * @param file the filename to get on local.
     * @return true if the method is succeeded.
     * @exception HttpException
     * @exception IOException
     */
    public boolean putMethod(String path, File file)
        throws HttpException, IOException {

        setClient();
        PutMethod method = new PutMethod(URIUtil.encodePathQuery(path));
        generateIfHeader(method);
        if (getGetContentType() != null && !getGetContentType().equals(""))
            method.setRequestHeader("Content-Type", getGetContentType());
        long fileLength = file.length();
        method.setRequestContentLength(fileLength <= Integer.MAX_VALUE
                                       ? (int) fileLength
                                       : PutMethod.CONTENT_LENGTH_CHUNKED);
        FileInputStream fis = new FileInputStream(file);
        method.setRequestBody(fis);
        generateTransactionHeader(method);
        int statusCode = client.executeMethod(method);

        setStatusCode(statusCode);

        fis.close();  // <--- simple update to code

        return (statusCode >= 200 && statusCode < 300) ? true : false;
    }
Comment 1 Antoine Levy-Lambert 2006-10-28 16:20:04 UTC
Thanks for your bug report.
Now fixed in SVN.
Will be available for the next release.
Comment 2 Michael N. Christoff 2007-02-08 14:38:06 UTC
I realize now that my proposed fix for this is inadequate.  The problem will
still arise if an exception occurs at any time after the FileInputStream 'fis'
is opened but before it is closed.  In that case, the method will exit without
having called fis.close().

Below is a solution that will ensure the stream closes even in the event of an
exception:

    public boolean putMethod(String path, File file)
        throws HttpException, IOException {


        FileInputStream fis = null;  // <- * declared outside of try block *
        try {        // <----------------- * try block added *


            setClient();
            PutMethod method = new PutMethod(URIUtil.encodePathQuery(path));
            generateIfHeader(method);
            if (getGetContentType() != null && !getGetContentType().equals(""))
                method.setRequestHeader("Content-Type", getGetContentType());
            long fileLength = file.length();
            method.setRequestContentLength(fileLength <= Integer.MAX_VALUE
                                           ? (int) fileLength
                                           : PutMethod.CONTENT_LENGTH_CHUNKED);
            fis = new FileInputStream(file);
            method.setRequestBody(fis);
            generateTransactionHeader(method);
            int statusCode = client.executeMethod(method);

            setStatusCode(statusCode);
            return (statusCode >= 200 && statusCode < 300) ? true : false;
            

        } finally {
            if(fis != null)      // <---- * stream closed in finally block *
                fis.close();
        }


    } 

By closing the stream in the finally block we gaurantee the stream will close.

Note: This is also an issue for putMethod(String, File) of the same class.  I
will submit a bug report and fix for this shortly.



Cheers!


Mike N. Christoff
dmx_dawg@hotmail.com
Comment 3 Antoine Levy-Lambert 2007-02-11 19:22:07 UTC
fix just committed in SVN, thanks