XXXIX. FTP

Wstęp

Funkcje z tego rozszerzenia implementują kliencki dostęp do plików serwera rozpoznającego File Transfer Protocol (FTP) opisanego w http://www.faqs.org/rfcs/rfc959. To rozszerzenie umożliwia dostęp do serwera FTP udostępniając szeroki zakres możliwości kontoli dla wykonującego skryptu. Jeśli chcesz tylko czytać z pliku na serwerze FTP lub do niego zapisywać, zastanów się nad użyciem wrappera ftp:// z funkcjami systemu plików które udostępniaja prostszy i bardziej intuicyjny interfejs.

Wymagania

Do zbudowania tego rozszerzenia nie są wymagane żadne zewnętrzne biblioteki.

Konfiguracja czasu wykonywania

To rozszerzenie nie definiuje posiada żadnych dyrektyw konfiguracyjnych w pliku php.ini.

Typy zasobów

To rozszerzenie korzysta z jednego typu zasobów, którym jest identyfikator połączenia FTP zwracany przez ftp_connect() lub ftp_ssl_connect().

Stałe predefinopwane

Poniższe stałe są zdefiniowane w tym rozszerzeniu i stają się dostępne, gdy rozszerzenie jest dokompilowane do PHP, lub załadowane dynamicznie przy starcie.

FTP_ASCII (integer)
FTP_TEXT (integer)
FTP_BINARY (integer)
FTP_IMAGE (integer)
FTP_TIMEOUT_SEC (integer)

Przykłady

Przykład 1. Przykład użycia FTP


<?php

// ustaw podstawowe połączenie

$conn_id = ftp_connect($ftp_server); 



// zaloguj się nazwą użytkownika i hasłem

$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass); 



// sprawdź połączenie

if ((!$conn_id) || (!$login_result)) { 

        echo "Połączenie FTP się nie powiodło!";

        echo "Próbowano połączyć się do $ftp_server jako użytkownik"

           . $ftp_user_name;

        exit; 

    } else {

        echo "Połączony z $ftp_server jako użytkownik $ftp_user_name";

    }



// prześlij plik

$upload = ftp_put($conn_id, $plik_docelowy, $plik_zrodlowy, FTP_BINARY); 



// sprawdź stan operacji

if (!$upload) { 

        echo "Wstawienie pliku przez FTP się nie powiodło!";

    } else {

        echo "Przesłano $plik_zrodlowy na $ftp_server jako $plik_docelowy";

    }



// zamknij strumień FTP

ftp_close($conn_id); 

?>

Spis treści
ftp_alloc -- Allocates space for a file to be uploaded
ftp_cdup -- Zmienia bieżący katalog na nadrzędny
ftp_chdir -- Zmienia katalog na serwerze FTP
ftp_chmod -- Set permissions on a file via FTP
ftp_close -- Zamyka połączenie FTP
ftp_connect -- Otwiera połączenie FTP
ftp_delete -- Usuwa plik z serwera FTP
ftp_exec -- Żądaj wywołania programu na serwerze FTP
ftp_fget -- Pobiera plik z serwera FTP i zapisuje go do otwartego pliku.
ftp_fput -- Umieszcza dane z otwartego pliku na serwerze FTP
ftp_get_option -- Pobiera różne opcje startowe strumienia FTP
ftp_get -- Pobiera plik z serwera FTP
ftp_login -- Loguje się w połączeniu FTP
ftp_mdtm -- Zwraca czas ostaniej modyfikacji podanego pliku
ftp_mkdir -- Tworzy katalog
ftp_nb_continue -- Continues retrieving/sending a file (non-blocking)
ftp_nb_fget -- Retrieves a file from the FTP server and writes it to an open file (non-blocking)
ftp_nb_fput -- Stores a file from an open file to the FTP server (non-blocking)
ftp_nb_get -- Retrieves a file from the FTP server and writes it to a local file (non-blocking)
ftp_nb_put -- Stores a file on the FTP server (non-blocking)
ftp_nlist -- Zwraca listę plików w podanym katalogu
ftp_pasv -- Włącza/wyłącza tryb pasywny
ftp_put -- Umieszcza plik na serwerze FTP
ftp_pwd -- Zwraca nazwę bieżącego katalogu
ftp_quit -- Zamyka połączenie FTP
ftp_raw -- Sends an arbitrary command to an FTP server
ftp_rawlist -- Zwraca szczegółową listę plików w podanym katalogu.
ftp_rename -- Zmienia nazwę pliku na serwerze FTP.
ftp_rmdir -- Usuwa katalog
ftp_set_option -- Ustaw różne opcje startowe FTP
ftp_site -- Wysyła serwerowi polecenie SITE.
ftp_size -- Zwraca rozmiar podanego pliku.
ftp_ssl_connect -- Opens an Secure SSL-FTP connection
ftp_systype -- Zwraca identyfikator systemu dla zdalnego serwera FTP.

User Contributed Notes


This is a simple script writen by me which allows the user

run it in console and get tree from FTP Server.



<?php

$argv = $_SERVER["argv"];

$argv = array_slice($argv,1);

if (getenv("HTTP_HOST")) {exit("For bash execution only!");}

if ((empty($argv[0])) || (empty($argv[1]))) {exit("Usage: thisscript.php 10.0.0.10 /games/Arcade/

where 10.0.0.10 is the FTP Server and /games/Arcade is the start path on FTP\n");}



// connect to the ftp server

$connect_id = ftp_connect($argv[0]);

// login on the server

if ($connect_id) { $login_result = ftp_login($connect_id, 'anonymous', 'JustForFun'); }

// check connection

if ((!$connect_id) || (!$login_result)) {

   echo "Unable to connect the remote FTP Server!\n";

   exit;

}

function ftp_get_dir ($ftp_dir) {

global $connect_id;

$ftp_contents = ftp_nlist ($connect_id, $ftp_dir);

    for ($myCounter_for_server_elements = 0; !empty ($ftp_contents[$myCounter_for_server_elements]);

$myCounter_for_server_elements++)

    {

// get elements list in current dir

        echo $argv[0] . $ftp_dir . $ftp_contents[$myCounter_for_server_elements] . "\n";

        ftp_get_dir ($ftp_dir . $ftp_contents[$myCounter_for_server_elements] . '/');

    }

}

ftp_get_dir ($argv[1]);

// close connection

ftp_close($connect_id);

?>


It may seem obvious to others, but it had me stumped for nearly an hour! If you can connect to an ftp site but some functions (list, put, get etc) don't work, then try using ftp_pasv and set passive mode on.



<?php



// setup $host and $file variables for your setup before here...



$hostip = gethostbyname($host);

$conn_id = ftp_connect($hostip);



// login with username and password

$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);



// IMPORTANT!!! turn passive mode on

ftp_pasv ( $conn_id, true );



if ((!$conn_id) || (!$login_result)) {

  echo "FTP connection has failed!";

  echo "Attempted to connect to $host for user $ftp_user_name";

  die;

} else {

  echo "Connected to $host, for user $ftp_user_name<br>";

  echo "Host IP is $hostip<br>";

  

  // upload a file

  if (ftp_put($conn_id, $remote_file, $file, FTP_ASCII)) {

    echo "successfully uploaded $file<br>";

  } else {

    echo "There was a problem while uploading $file<br>";

  }

    

  // close the connection

  ftp_close($conn_id);

}

?>


If you prefer a OO-approach to the FTP-functions, you can use this snippet of code (PHP5 only! and does add some overhead). It's just a "start-up", extend/improve as you wish...

You can pass all ftp_* functions to your object and stripping ftp_ of the function name. Plus, you don't have to pass the ftp-resource as the first argument.



For example:

<?php

ftp_delete($ftp, $file);    // Where $ftp is your ftp-resource

?>



Can become:

<?php

$ftp->delete($file);        // Where $ftp is your FTP-object

?>



Code:

<?php



class FTP {



    private $ftp;

    

    /* public Void __construct(): Constructor */

    public function __construct($host, $port = 21, $timeout = 90) {

        $this->ftp = ftp_connect($host, $port, $timeout);

    }

    

    /* public Void __destruct(): Destructor */

    public function __destruct() {

        @ftp_close($this->ftp);

    }



    /* public Mixed __call(): Re-route all function calls to the PHP-functions */

    public function __call($function, $arguments) {

        // Prepend the ftp resource to the arguments array

        array_unshift($arguments, $this->ftp);

        

        // Call the PHP function

        return call_user_func_array('ftp_' . $function, $arguments);

    }

    

}



?>


Here's a little function that I created to recurse through a local directory and upload the entire contents to a remote FTP server.



In the example, I'm trying to copy the entire "iwm" directory located at /home/kristy/scripts/iwm to a remote server's /public_html/test/ via FTP.



The only trouble is that for the line "if (!ftp_chdir($ftpc,$ftproot.$srcrela))", which I use to check if the directory already exists on the remote server, spits out a warning about being unable to change to that directory if it doesn't exist.



But an error handler should take care of it.



My thanks to the person who posted the snippet on retrieving the list of files in a directory.



For the version of the script that echo's it's progress as it recurses & uploads, go to: http://pastebin.com/73784



<?php



// --------------------------------------------------------------------

// THE TRIGGER

// --------------------------------------------------------------------



    // set the various variables

    $ftproot = "/public_html/test/";

    $srcroot = "/home/kristy/scripts/";        

    $srcrela = "iwm/";



    // connect to the destination FTP & enter appropriate directories both locally and remotely

    $ftpc = ftp_connect("ftp.mydomain.com");

    $ftpr = ftp_login($ftpc,"username","password");



    if ((!$ftpc) || (!$ftpr)) { echo "FTP connection not established!"; die(); }

    if (!chdir($srcroot)) { echo "Could not enter local source root directory."; die(); }

    if (!ftp_chdir($ftpc,$ftproot)) { echo "Could not enter FTP root directory."; die(); }



    // start ftp'ing over the directory recursively

    ftpRec ($srcrela);



    // close the FTP connection

    ftp_close($ftpc);



// --------------------------------------------------------------------

// THE ACTUAL FUNCTION

// --------------------------------------------------------------------

function ftpRec ($srcrela)

{

    global $srcroot;

    global $ftproot;

    global $ftpc;

    global $ftpr;

                

    // enter the local directory to be recursed through

    chdir($srcroot.$srcrela);

    

    // check if the directory exists & change to it on the destination

    if (!ftp_chdir($ftpc,$ftproot.$srcrela))

    {

        // remote directory doesn't exist so create & enter it

           ftp_mkdir    ($ftpc,$ftproot.$srcrela);

           ftp_chdir    ($ftpc,$ftproot.$srcrela);

    }



    if ($handle = opendir("."))

    {

       while (false !== ($fil = readdir($handle)))

       {

           if ($fil != "." && $fil != "..")    

           {

               // check if it's a file or directory

               if (!is_dir($fil))

               {    

                   // it's a file so upload it

                   ftp_put($ftpc, $ftproot.$srcrela.$fil, $fil, FTP_BINARY);

                }

                else

                {

                    // it's a directory so recurse through it

                    if ($fil == "templates")

                    {

                            // I want the script to ignore any directories named "templates"

                            // and therefore, not recurse through them and upload their contents

                    }

                    else

                    {

                        ftpRec ($srcrela.$fil."/");

                        chdir ("../");

                    }

                }

          }

      }

      closedir($handle);

    }    

}

?>


<?



//If you want to move or replicate the folder hierarchy from your current server to another remote server. Then this will be helpful as this will browse the current server's directory and at the same time it will copy that file in the remote server in the same directory. 



//This script will copy all the files from this directory and subdirectory to another remote server via FTP



function rec_copy ($source_path, $destination_path, $con)

{

    ftp_mkdir($con, $destination_path);

    ftp_site($con, 'CHMOD 0777 '.$destination_path);

    ftp_chdir($con,$destination_path);



    if (is_dir($source_path)) 

    {

        chdir($source_path);

        $handle=opendir('.');

        while (($file = readdir($handle))!==false) 

        {

            if (($file != ".") && ($file != "..")) 

            {

                if (is_dir($file))

                {

                    // here i am restricting the folder name 'propertyimages' from being copied to remote server. -- VK

                    if($file != "propertyimages")

                    {

                        rec_copy ($source_path."/".$file, $file, $con);

                        chdir($source_path);

                        ftp_cdup($con);

                    }

                }

                if (is_file($file))

                {

                    $fp = fopen($file,"r");

                    // this will convert spaces to '_' so that it will not throw error.  -- VK

                    ftp_fput ($con, str_replace(" ", "_", $file), $fp,FTP_BINARY);

                    ftp_site($con, 'CHMOD 0755 '.str_replace(" ", "_", $file));

                } 

            }

        }

        closedir($handle); 

    }

}



// make a FTP connection --VK

$con = ftp_connect("69.18.213.131",21);

$login_result = ftp_login($con,"username","password");    



// this is the root path for the remote server-- VK

$rootpath = "mainwebsite_html";    



// this is the physical path of the source directory. actually u can also use the relative path. -- VK

$sourcepath = realpath("../")."/resdesk";



// this directory name will only change the top most directory and not the inner one -- VK

$destination_dir_name = "resdesk_".$account_id."/";



rec_copy ($sourcepath, $destination_dir_name, $con);

if (function_exists("ftp_close")) 

{

    ftp_close($con);

}

?>