XLIII. Функции для работы с FTP

Введение

Функции этого модуля обеспечивают доступ к серверам по протоколу FTP (File Transfer Protocol), определенному в http://www.faqs.org/rfcs/rfc959. Модуль позволяет выполнять множество довольно сложных операций. Если требуется лишь прочитать или записать файл на сервере FTP, можно воспользоваться ftp:// ссылками и функциями для работы с файловой системой, которые более просты в использовании.

Требования

Эти функции всегда доступны.

Установка

Для использования FTP функций, вы должны указать директиву --enable-ftp во время установки PHP 4 или --with-ftp при использовании PHP 3.

Версия PHP для Windows имеет встроенную поддержку данного расширения. Это означает, что для использования данных функций не требуется загрузка никаких дополнительных расширений.

Настройка во время выполнения

Данное расширение не определяет никакие директивы конфигурации в php.ini.

Типы ресурсов

Этот модуль использует один тип ресурса - идентификатор соединения с FTP сервером, возвращаемый функцией ftp_connect() или ftp_ssl_connect().

Предопределенные константы

Перечисленные ниже константы определены данным расширением и могут быть доступны только в том случае, если PHP был собран с поддержкой этого расширения или же в том случае, если данное расширение подгружается во время выполнения.

FTP_ASCII (integer)

FTP_TEXT (integer)

FTP_BINARY (integer)

FTP_IMAGE (integer)

FTP_TIMEOUT_SEC (integer)

Дополнительная информация доступна в описании функции ftp_set_option().

Следующие константы появились в PHP 4.3.0.

FTP_AUTOSEEK (integer)

Дополнительная информация доступна в описании функции ftp_set_option().

FTP_AUTORESUME (integer)

Автоматически определять позицию в файле, с которой начинается докачка при использовании команд GET и PUT (имеет смысл только совместно с FTP_AUTOSEEK)

FTP_FAILED (integer)

Асинхронная операция завершилась неудачно

FTP_FINISHED (integer)

Асинхронная операция окончена

FTP_MOREDATA (integer)

Асинхронная операция еще не завершена

Примеры

Пример 1. Пример использования функций FTP

<?php
// установка соединения
$conn_id = ftp_connect($ftp_server);

// вход с именем пользователя и паролем
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);

// проверка соединения
if ((!$conn_id) || (!$login_result)) {
       echo "Не удалось установить соединение с FTP сервером!";
       echo "Попытка подключения к серверу $ftp_server под именем $ftp_user_name!";
       exit;
   } else {
       echo "Установлено соединение с FTP сервером $ftp_server под именем $ftp_user_name";
   }

// закачивание файла
$upload = ftp_put($conn_id, $destination_file, $source_file, FTP_BINARY);

// проверка результата
if (!$upload) {
       echo "Не удалось закачать файл!";
   } else {
       echo "Файл $source_file закачен на $ftp_server под именем $destination_file";
   }

// закрытие соединения
ftp_close($conn_id);
?>

Содержание
ftp_alloc -- Резервирует место на диске для закачиваемого файла
ftp_cdup -- Переходит в родительскую директорию
ftp_chdir -- Изменяет текущую директорию на FTP сервере
ftp_chmod -- Устанавливает права доступа к файлу
ftp_close -- Закрывает соединение с FTP сервером
ftp_connect -- Устанавливает соединение с FTP сервером
ftp_delete -- Удаляет файл на FTP сервере
ftp_exec -- Выполняет программу на FTP сервере
ftp_fget -- Загружает файл с FTP сервера и сохраняет его в предварительно открытом файле
ftp_fput -- Загружает предварительно открытый файл на FTP сервер
ftp_get_option -- Получает текущие параметры FTP соединения
ftp_get -- Загружает файл с FTP сервера
ftp_login -- Выполняет вход на FTP сервер
ftp_mdtm -- Возвращает время последней модификации файла
ftp_mkdir -- Создаёт директорию
ftp_nb_continue -- Продолжает асинхронную операцию
ftp_nb_fget -- Скачивает файл с FTP сервера в асинхронном режиме и сохраняет его в предварительно открытом файле
ftp_nb_fput -- Загружает предварительно открытый файл на FTP сервер в асинхронном режиме
ftp_nb_get -- Скачивает файл с FTP сервера в асинхронном режиме и сохраняет его в локальный файл
ftp_nb_put --  Загружает файл на FTP сервер в асинхронном режиме
ftp_nlist -- Возвращает список файлов в заданной директории
ftp_pasv -- Включает или выключает пассивный режим
ftp_put -- Загружает файл на FTP сервер
ftp_pwd -- Возвращает имя текущей директории
ftp_quit -- Псевдоним функции ftp_close()
ftp_raw -- Отправляет произвольную команду FTP серверу
ftp_rawlist -- Возвращает список файлов в заданной директории
ftp_rename -- Переименовывает файл на FTP сервере
ftp_rmdir -- Удаляет директорию
ftp_set_option -- Устанавливает параметры соединения с FTP сервером
ftp_site -- Отправляет команду SITE серверу
ftp_size -- Возвращает размер файла
ftp_ssl_connect -- Устанавливает соединение с FTP сервером через SSL
ftp_systype -- Возвращает тип операционной системы FTP сервера


Функции для работы с FTP
magic2lantern at mail dot ru
23-Dec-2005 08:19
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);
?>
leonardo at rol dot com dot ro
09-Aug-2005 06:51
Here is an example for downloading a remote ftp structure to local server, useful for migrating sites from one server to another, especially when you are upgrading ensim ;)

http://leonardo.rol.ro/ftpleech.txt
dickiedyce at uk dot com
07-May-2005 08:20
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);
}
?>
arjen at queek dot nl
15-Jul-2004 07:38
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);
   }
  
}

?>
Kristy Christie (kristy at isp7 dot net)
15-Jun-2004 11:50
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);
   }   
}
?>
postmaster at alishomepage dot com
24-Jan-2004 03:29
I have written an OpenSource ZIP2FTP interface, which actually takes a given ZIP file and decompresses it in the folder on an FTP server you specify...

Therefore it may be quite interesting for you people interested in FTP, its adress is http://zip2ftp.alishomepage.com ; those who directly want the source may visit http://zip2ftp.alishomepage.com/?do=getSource
Vikrant Korde <vakorde at hotmail dot com>
14-Nov-2003 05:35
<?

//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);
}
?>
postmaster at alishomepage dot com
24-Oct-2003 04:06
Here's another FTP interface over PHP (also uses MySQL)

http://myftp.alishomepage.com

PS: this script will ALSO allow you to download its source... So it becomes interesting for YOU PROGRAMMERS as well :D
arjenjb dot wanadoo dot nl
09-Mar-2003 10:29
Check http://nanoftpd.sourceforge.net/ for a FTP server written in PHP.
Supports Passive and Active FTP, and all other standard FTP commands as decribed in RFC959.
NOSPAMkent at ioflux dot NOSPAM dot com
19-Sep-2002 05:05
I think what some other posts were trying to say which may need clarification is that in PHP 4.2.3, ftp_connect("myhost.com") was failing most of the time, except it would work like every few minutes.

The fix is that ftp_connect seems to have a bug resolving addresses. If you do:

$hostip = gethostbyname($host);
$conn_id = ftp_connect($hostip);

It seems to solve the problem.
(Other users referred to an ftpbuf() error... not sure what that is, but this should fix it.)
sven at cartell-network dot de
13-Feb-2002 11:27
connection to a ftp server across proxy

$ftp_server = "proxy"; f.e. 123.456.789.10
$ftp_user_name = "username@ftpserver"; f.e. exampleuk@www.example.uk
$ftp_user_pass = "password";

$conn_id = ftp_connect($ftp_server, 2121);
$login_result = ftp_login( $conn_id, $ftp_user_name, $ftp_user_pass );

<fbsql_warningsftp_alloc>
 Last updated: Tue, 15 Nov 2005