Skip to content

Commit

Permalink
Adding ftplib. Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
PeqNP committed Mar 13, 2014
1 parent 6988cc7 commit f79ded6
Show file tree
Hide file tree
Showing 50 changed files with 6,320 additions and 7 deletions.
178 changes: 178 additions & 0 deletions Libraries/include/ftplib/CHANGES
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
The obligatory revision history...

Changes from V3.1-1 to V4.0

1) License changed from GPL/LGPL to Artistic License 2.0.

2) Many bugs reported over the years have been addressed.

3) The reentrant versions of gethostbyname and getservbyname are used
if available.

4) Internal buffers are larger which should allow for longer
filenames.

5) The library will not output anything to stdout or stderr unless
ftplib_debug is defined.

6) Some additional arguments are declared const.

7) The second argument to FtpSize is the address of an integer to
receive the size of the remote file. The type of this argument has
been changed from int to unsigned int. A new function, FtpSizeLong,
returns the remote file's size as an unsigned long long.

8) The second argument to the callback function has been changed from
an int to an unsigned long long. This value contains the number of
bytes transferred so far.

9) The library version 1 interface compatability macros have been
removed from the header file. If your application needs them, extract
them from the old header file.

10) The usage information in qftp.c has been corrected.

11) qftp now accepts a '-s <cmd>' option to send <cmd> as a SITE
command.

12) qftp progress reports now use floating point calculation so that
large numbers don't cause overflows. If the remote server does not
support the SIZE command, qftp will update every 32KB.

13) A new type-safe method is provided to establish a callback
function. Put the details of when the function should be called into
a FtpCallbackOptions structure and pass it to FtpSetCallback(). To
remove a callback, call FtpClearCallback().

14) Updated html documentation.

Changes from V3.1 to V3.1-1

1) Delay setting the control handle pointer in the data handle until
after the transfer request has received a positive acknowledgement.
This should resolve problems calling FtpClose() on the data handle
when the transfer is rejected.

2) Fix error handling in FtpRead() and FtpWrite().

3) Return status of transfer from FtpXfer() instead of status of
FtpClose().

4) Allow FtpClose() to be called on a control handle. This should be
used instead of FtpQuit() in cases where a transfer was interrupted.
FtpQuit() would attempt to send a 'QUIT' command and wait for a
response but this would be out of sync after an interrupt.

5) The idle callback routine was not being set in the data handle if
the user didn't set FTPLIB_IDLETIME. Fixed this so it would get set
up if either this or FTPLIB_CALLBACKBYTES was set.

6) Open local files in binary mode when appropriate. This is
necessary on some systems like NT and VMS.

7) Added a wildcard mode to qftp for wildcard retrieves. Argument
after '-w' is treated as a remote wildcard file specification.

Changes from 12/2/97 (V3) to .... (V3.1)

1) Added FtpPwd(), FtpSysType(), FtpCDUp(), FtpSize() and FtpModDate().

2) Fixed bug in FtpClose() - It wasn't waiting for the '226 Transfer
Complete' since it didn't have access to the control connection. A
pointer to it is now kept in the data connection.

3) Fixed bug in FtpClose() - The data connection wasn't being freed. This
could have resulted in memory leaks.

4) Allow runtime selection of connection mode (PORT/PASV) with default set
at compile time.

5) Added support for a user callback routine which can get called after a
user specified number of bytes are transferred or after waiting for data
on a socket for a user specified time period.

6) Add FtpOptions() which allows changing connection options. Options
include connection mode, callback routine, and parameters regarding when
the user's callback routine gets called.

7) Added checks to make sure strcpy()/sprintf()/etc. wouldn't write past
end of buffers.

8) Modified build procedure to create a shared library.

9) Added install option to makefile which installs under /usr/local.

10) Modified qftp to use new interface.

11) Modified qftp to log progress every 10% of file or every time data
is delayd by 1 second if -v setting is not zero.

12) Modified qftp to use fgets() instead of gets().

------------------------------------------------------------------------

Changes from 3/15/97 to 12/2/97

1) FtpLastResponse() returns NULL if passed a NULL pointer.

2) Added 'const' keyword on appropriate function arguments.

3) First attempt to translate passed host string as an IP address in dot
notation by passing it to inet_addr(). If this fails, pass the string
to gethostbyname(). Apparently, some versions of gethostbyname() will
parse the translation of a dot notation address for you. One user
reports he knows of at least one that does not. In any case, it's the
right thing to do.

4) Added protection from double inclusion to header file. Also added
'extern "C"' for C++.

5) Made sure qftp was passed two arguments before examining the second
one.

6) Made sure all commands to the server were in upper case. I've been
told that some servers require this.

7) Attempt to handle login to accounts with no passwords.

8) Added common data transfer routines so that ascii mode transfers would
be handled properly in all cases. Also, exposed these routines for
user programs to call. There's now FtpAccess() to open a remote file
or directory, FtpRead() and FtpWrite() to pass data, and FtpClose() to
terminate the data connection.

9) Added 'list' command to qftp to perform a terse directory (names
only). This could be piped into another copy of qftp to retrieve the
files.

10) ftplib.c and ftplib.h are now covered by the LGPL instead of the GPL.
Feel free to send me a complementary copy of anything you develop
commercially with my libraries. All other programs are still covered
by the GPL.

11) Added ability to specify a different port number than the default by
appending a colon and the desired port number to the remote host name
(e.g., remote.host.name:500 would connect to port remote.host.name on
port 500).

------------------------------------------------------------------------

Changes from 8/31/96 version to 3/15/97 version

1) Added copyright information to sources.

2) Changed from 'port' to 'pasv' which I'm told will allow the routines
to work from behind a firewall. It's also a lot simpler and cleaner
than all that code to setup and accept a connect from the server.

3) Added delete (ftprm) support to qftp.c.

4) Modified qftp to allow use without a softlink by passing the ftp
command as the first argument.

5) Added netbuf argument to all calls to eliminate static storage and
allow multiple simultaneous connections.

6) Renamed routines from ftp*() to Ftp*() to avoid problems with existing
programs. Added macros in libftp.h to support old interface. Renamed
ftpOpen() to FtpConnect().
171 changes: 171 additions & 0 deletions Libraries/include/ftplib/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
Artistic License 2.0

Copyright (c) 2000-2006, The Perl Foundation.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed. Preamble

This license establishes the terms under which a given free software
Package may be copied, modified, distributed, and/or
redistributed. The intent is that the Copyright Holder maintains some
artistic control over the development of that Package while still
keeping the Package available as open source and free software.

You are always permitted to make arrangements wholly outside of this
license directly with the Copyright Holder of a given Package. If the
terms of this license do not permit the full use that you propose to
make of the Package, you should contact the Copyright Holder and seek
a different licensing arrangement. Definitions

"Copyright Holder" means the individual(s) or organization(s) named in
the copyright notice for the entire Package.

"Contributor" means any party that has contributed code or other
material to the Package, in accordance with the Copyright Holder's
procedures.

"You" and "your" means any person who would like to copy, distribute,
or modify the Package.

"Package" means the collection of files distributed by the Copyright
Holder, and derivatives of that collection and/or of those files. A
given Package may consist of either the Standard Version, or a
Modified Version.

"Distribute" means providing a copy of the Package or making it
accessible to anyone else, or in the case of a company or
organization, to others outside of your company or organization.

"Distributor Fee" means any fee that you charge for Distributing this
Package or providing support for this Package to another party. It
does not mean licensing fees.

"Standard Version" refers to the Package if it has not been modified,
or has been modified only in ways explicitly requested by the
Copyright Holder.

"Modified Version" means the Package, if it has been changed, and such
changes were not explicitly requested by the Copyright Holder.

"Original License" means this Artistic License as Distributed with the
Standard Version of the Package, in its current version or as it may
be modified by The Perl Foundation in the future.

"Source" form means the source code, documentation source, and
configuration files for the Package.

"Compiled" form means the compiled bytecode, object code, binary, or
any other form resulting from mechanical transformation or translation
of the Source form. Permission for Use and Modification Without
Distribution

(1) You are permitted to use the Standard Version and create and use
Modified Versions for any purpose without restriction, provided that
you do not Distribute the Modified Version. Permissions for
Redistribution of the Standard Version

(2) You may Distribute verbatim copies of the Source form of the
Standard Version of this Package in any medium without restriction,
either gratis or for a Distributor Fee, provided that you duplicate
all of the original copyright notices and associated disclaimers. At
your discretion, such verbatim copies may or may not include a
Compiled form of the Package.

(3) You may apply any bug fixes, portability changes, and other
modifications made available from the Copyright Holder. The resulting
Package will still be considered the Standard Version, and as such
will be subject to the Original License. Distribution of Modified
Versions of the Package as Source

(4) You may Distribute your Modified Version as Source (either gratis
or for a Distributor Fee, and with or without a Compiled form of the
Modified Version) provided that you clearly document how it differs
from the Standard Version, including, but not limited to, documenting
any non-standard features, executables, or modules, and provided that
you do at least ONE of the following:

(a) make the Modified Version available to the Copyright Holder of the
Standard Version, under the Original License, so that the Copyright
Holder may include your modifications in the Standard Version. (b)
ensure that installation of your Modified Version does not prevent the
user installing or running the Standard Version. In addition, the
Modified Version must bear a name that is different from the name of
the Standard Version. (c) allow anyone who receives a copy of the
Modified Version to make the Source form of the Modified Version
available to others under (i) the Original License or (ii) a license
that permits the licensee to freely copy, modify and redistribute the
Modified Version using the same licensing terms that apply to the copy
that the licensee received, and requires that the Source form of the
Modified Version, and of any works derived from it, be made freely
available in that license fees are prohibited but Distributor Fees are
allowed. Distribution of Compiled Forms of the Standard Version or
Modified Versions without the Source

(5) You may Distribute Compiled forms of the Standard Version without
the Source, provided that you include complete instructions on how to
get the Source of the Standard Version. Such instructions must be
valid at the time of your distribution. If these instructions, at any
time while you are carrying out such distribution, become invalid, you
must provide new instructions on demand or cease further
distribution. If you provide valid instructions or cease distribution
within thirty days after you become aware that the instructions are
invalid, then you do not forfeit any of your rights under this
license.

(6) You may Distribute a Modified Version in Compiled form without the
Source, provided that you comply with Section 4 with respect to the
Source of the Modified Version. Aggregating or Linking the Package

(7) You may aggregate the Package (either the Standard Version or
Modified Version) with other packages and Distribute the resulting
aggregation provided that you do not charge a licensing fee for the
Package. Distributor Fees are permitted, and licensing fees for other
components in the aggregation are permitted. The terms of this license
apply to the use and Distribution of the Standard or Modified Versions
as included in the aggregation.

(8) You are permitted to link Modified and Standard Versions with
other works, to embed the Package in a larger work of your own, or to
build stand-alone binary or bytecode versions of applications that
include the Package, and Distribute the result without restriction,
provided the result does not expose a direct interface to the Package.
Items That are Not Considered Part of a Modified Version

(9) Works (including, but not limited to, modules and scripts) that
merely extend or make use of the Package, do not, by themselves, cause
the Package to be a Modified Version. In addition, such works are not
considered parts of the Package itself, and are not subject to the
terms of this license. General Provisions

(10) Any use, modification, and distribution of the Standard or
Modified Versions is governed by this Artistic License. By using,
modifying or distributing the Package, you accept this license. Do not
use, modify, or distribute the Package, if you do not accept this
license.

(11) If your Modified Version has been derived from a Modified Version
made by someone other than you, you are nevertheless required to
ensure that your Modified Version complies with the requirements of
this license.

(12) This license does not grant you the right to use any trademark,
service mark, tradename, or logo of the Copyright Holder.

(13) This license includes the non-exclusive, worldwide,
free-of-charge patent license to make, have made, use, offer to sell,
sell, import and otherwise transfer the Package with respect to any
patent claims licensable by the Copyright Holder that are necessarily
infringed by the Package. If you institute patent litigation
(including a cross-claim or counterclaim) against any party alleging
that the Package constitutes direct or contributory patent
infringement, then this Artistic License to you shall terminate on the
date that such litigation is filed.

(14) Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT
HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT
PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT
HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE
OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
18 changes: 18 additions & 0 deletions Libraries/include/ftplib/README.ftplib-4.0
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
FTP Library Routines Release 4.0
Thomas Pfau (tfpfau@gmail.com)
June 7, 2013

This package implements a callable interface to FTP. The FTP protocol is
specified in RFC 959. The library has been tested on linux, OpenVMS and
Windows NT. It should also work without major modification on other
POSIX systems.

All programs using the library should include ftplib.h.

The routines look at the global variable ftplib_debug to determine how
much information they should display. Level 1 has been left for user
programs. Level 2 displays all responses received from the server.
Level 3 displays all commands sent to the server.

Function documentation is provided in HTML format in the html
subdirectory.
Loading

0 comments on commit f79ded6

Please sign in to comment.