Subir ficheros al servidor con una tarea Phake

25 de agosto de 20145 min de lectura
En un artículo anterior os hablamos de Phake, una herramienta para PHP que nos permitía automatizar ciertas tareas repetitivas y tediosas. Hoy vamos a ir un poco más adelante y vamos a ver un ejemplo de uso real. En concreto crearemos una tarea que se encargará de subir archivos a nuestro servidor.

En concreto, nuestra tarea hará la subida de archivos al servidor utilizando para ello el protocolo FTP. El código encargado de realizar esta tarea es el siguiente.


task('up', function($args){
$host = $args['host'];
$user = $args['user'];
$pass = $args['pass'];
$port = 21; //Puerto por defecto del FTP
$timeout = 60; //timeout para la subida de archivos individuales

//Conectamos al servidor vía FTP
$ftp = ftp_connect($host, $port, $timeout);
ftp_login($ftp, $user, $pass); //login al servidor

$root_local_dir = $args['local_path'];
$root_ftp_dir = $args['remote_path'];
$dir_to_upload = $args['local_path'];

$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir_to_upload), RecursiveIteratorIterator::SELF_FIRST);

//iteramos sobre todos los archivos y carpetas en el directorio especificado
foreach($iterator as $path){
//Si el path actual hace referencia a un archivo
if($path->isFile()){

$current_file = $path->__toString();
$dest_file = str_replace($root_local_dir, $root_ftp_dir, $current_file);
$result = ftp_nb_put($ftp, $dest_file, $current_file, FTP_BINARY);

//mientras no se llegue al final del archive, se mantiene la subida
while($result == FTP_MOREDATA){
$result = ftp_nb_continue($ftp);
}

//una vez que el fichero se ha subido completamente
if($result == FTP_FINISHED){
echo "subido: " . $current_file . "n";
}

}else{
//Si la ruta hace referencia a un directorio
$current_dir = $path->__toString();

//si el nombre del directorio no empieza con punto
if(substr($current_dir, -1) != '.'){
//eliminamos la ruta del directorio de la actual path
$current_dir = str_replace($root_local_dir, '', $current_dir);
//eliminamos la barra (/) de la ruta actual
$current_dir = substr($current_dir, 1);

//creamos el directorio en el servidor
ftp_mksubdirs($ftp, $root_ftp_dir, $current_dir);
echo "directorio creado: " . $current_dir . "n";
}
}
}
});


Como podemos ver en el código anterior, la tarea acepta cinco argumentos:

- Host: el nombre del dominio o dirección IP del servidor donde subiremos los archivos.
- User: usuario ftp
- Pass: contraseña ftp
- Local_path: ruta hacia el directorio que queremos subir al servidor
- Remote_path: la ruta en el servidor

Luego nosotros nos conectamos con nuestras credenciales mediante el método ftp_connect. Este método nos devuelve una cadena que luego la utilizamos para conectarnos al servidor junto con nuestro usuario y contraseña mediante la función ftp_login.

Una vez logueados, realizaremos una iteración por todos los archivos que forman parte del directorio local utilizando los objetos “recursive iterator iterator” y “recursive directory iterator” de PHP. El objeto “recursive iterator iterator” recibe como primer argumento un objeto del tipo “recursive directory iterator” y como segundo argumento una constante definida en su clase. En nuestro caso hemos utilizado la constante “RecursiveIteratorIterator::SELF_FIRST” con lo que le estamos indicando al iterador que incluya la ruta completa en cada pasada. A continuación, recorremos todos los archivos y directorios de ese path utilizando la instrucción “foreach”.

Chequeamos si la ruta actual es un archivo con el método “isFile”. Si es un archivo, hacemos uso del método __toString para convertirlo en cadena y asignarle el valor a la variable $current_file. Declaramos la variable $dest_file que contendrá la ruta del archivo actual pero sin la ruta al directorio root. Esto se usará como el nombre del archivo que crearemos en el servidor. Cuando esas variables tienen asignados los valores, las podemos utilizar como argumentos en el método “ftp_nb_put”. Como primer argumento le pasaremos la cadena devuelta de la conexión, como segundo será el path del fichero en el servidor y el tercero será el path del archivo en nuestra máquina local. Le pasaremos un cuarto argumento que será el modo de transferencia, en nuestro caso utilizamos “FTP_BINARY”.

Para realizar la subida del archivo, hacemos uso del método “ftp_nb_continue” al que le pasamos la cadena de conexión. Este método retorna “FTP_MOREDATA” mientras que no se haya terminado la subida, por lo que utilizamos un “while” para que se repita la acción mientras que esto ocurre. Cuando se ha subido todo, devuelve “FTP_FINISHED”.

Si la ruta actual es un directorio, lo convertimos a cadena y comprobamos si empieza por “.”, ya que descartaremos aquellos que empiezan así porque son archivos que contienen meta datos o información de la versión.

Utilizamos el método “str_replace” para reemplazar la parte del nombre que no queremos que se cree en el servidor.

Una vez hecho todo esto, ya utilizamos la llamada al método “ftp_mksubdirs” para crear el directorio en el servidor de destino. Este método creará el directorio siempre y cuando no exista en la ruta indicada.

Podemos ejecutar esta tarea desde un terminal ejecutando el siguiente comando.

phake up host=someserver.com user=me pass=secret local_path=/home/wern/www/someproject remote_path=/public_html


Este es solo un ejemplo de lo que se puede hacer con la herramienta Phake, pero podríamos hacer cualquier cosa que se nos ocurriera, como insertar información en una base de datos, hacer un envío de correos electrónicos,….

Sigue leyendo