###############################################################################
# ABOUT                                                                       #
###############################################################################

This a test version for the new curl 'ftp' module for UTStats which aims to add
sftp and ftp support through the libcurl library. Although libcurl supports
more protocols than sftp and ftp not all required functions (e.g. deleting
files) are available and these have to be specified for each of these protocols.
Other protocols can be added on request.

###############################################################################
# Requirements                                                                #
###############################################################################

- php5-curl
  See http://curl.haxx.se/libcurl/php/ for details, php5-curl might allready be
  installed or can be installed with your favourite package manager.

  In Ubuntu sftp might not be build in, see the bug report for details:
  https://bugs.launchpad.net/ubuntu/+source/curl/+bug/311029

- authenticated remote host
  cURL checks the authentication of the remote host but can't authenticate it
  if it's unknown. If you want to use sftp you'll have to manually authenticate
  the remote host. You can add the RSA fingerprint to ~/.ssh/known_hosts or
  simply connect to it once. (I have no idea how this works on windows
  servers).


###############################################################################
# Installation                                                                #
###############################################################################

1. Copy the includes directory including the files to your UTStats install
   This will overwrite the following file:
   - includes/ftp.php

   This will add the following file:
   - includes/ftp_class_curl.php

2. Open includes/config.ini

3. Set $ftp_type = "curl"

4. For sftp connections set $ftp_hostname[$i] = 'sftp://your-host';

   For ftp connections you can use the normal settings as suggested in the
   config file.

5. Set $ftp_delete = true; 

###############################################################################
# TODO                                                                        #
###############################################################################

 * Clean up, always clean up
 * Add rename support (for future versions)
 * Add support for other protocols if required


###############################################################################
# Used packages & Thanks                                                      #
###############################################################################

 * cURL by various contributors - http://curl.haxx.se/
 * http_build_url by an unknown user - http://www.mediafire.com/?zjry3tynkg5
 * `iDeFiX - as always

###############################################################################
# License & Stuff                                                             #
###############################################################################

This software is distributed under the Open Unreal Mod License, see license.txt
This software comes without any warranty, use it at your own risk. 