Diferencia entre revisiones de «Plantilla:PHP/Formularios/transmisionFicheros»

Revisión de 20:33 16 oct 2017

Transfiriendo ficheros entre cliente y servidor

• Es muy sencillo y frecuente subir ficheros entre cliente y servidor

• Cuando vamos a subir ficheros hay que conocer acciones a indicar tanto en la parte de cliente como en la de servidor.

Acciones en el Cliente

input type=file

• Debemos especificar un elemento input con de type file en un formulario
• Como todo input debe tener asignado un name para acceder a él en el servidor

<input type=file name=fichero>

form method=POST enctype="multipart/form-data

• El formulario donde esté el input ha de tener especificado el atributo enctype establecido con el valor mutipart/form-data.
• Cuando no especificamos tipo, se asume por defecto el valor application/x-www-form-urlencoded. Este valor implica que enviamos texto plano y lo podremos enviar tanto por GET como por POST.
• No obstante si vamos a transferir un fichero no necesariamente de texto debemos especificarlo estableciendo el valor de enctype a mutipart/form-data. Este valor se emplea para transferir gran cantidad de texto u otros formatos de fichero entre cliente y servidor

Recursos de la Web

https://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#form-content-type

enctype es un atributo necesario para especificar el tipo de contenio usado para enviar la información del formulario al servidor

• Necesariamente hemos de usar el método POST para este cometido

<form action='' method=POST entype='multipart/form-data'>
....
</form>

Establecer tamaño en el cliente

• El tamaño de bytes que vamos a enviar también puede quedar establecido en el cliente, de modo que si el fichero tiene un tamaña mayor, no se envía
• Para esto se establece antes del input file, un input hidden con name = MAX_SIZE_FILE y value el valor del tamaño máximo.
• Este mecanismo no avisa al cliente de nada, simplemente dejará de enviar el fichero al servidor en caso de exceder el tamaño.
• En el servidor se recibirá un error de valor 2 o constante UPLOAD_ERR_FORM_SIZE, (Ver código de errores más abajo o en http://php.net/manual/es/features.file-upload.errors.php
• Con todo lo dicho, la especificación en el cliente quedaría

  <form action="descarga.php" method="POST" enctype="multipart/form-data">
            <input type="hidden" name="MAX_FILE_SIZE" value="10000000">
            <h3>Selecciona fichero </h3>
            <input type="file" name="fichero" id="" >
            <br />
            <input type="submit" value="Acceder" name="descarga">
        </form>

Acciones en el Servidor: $_FILES

• La forma de acceder al input del tipo file que viene del cliente en la solicitud al servidor es a través de la superglobal $_FILES
• Lo primero que deberemos hacer es acceder a este elemento con el nombre del input

$fichero = $_FILES['nombre_input_file']

• $_FILES es un array asociativo con tantos elementos con input de tipo file vengan del formulario cuyo submit ha generado una solicitud al servidor
• Cada posición a su vez contiene un array asociativo con información de ese fichero alamacenada en 5 componentes:

1. name Nombre del fichero en el cliente
2. type Tupo de fichero subido
3. size Tamaño en bytes del fichero
4. tpm_name Nombre asignado de forma temporal en el servidor
5. error Error que se haya podido producir o 0 si no ha habido ninguno (Ver tabla más abajo)

Con el fichero que viene del cliente, en el servidor podemos hacer una serie de acciones:

1. Capturar el fichero y dejarlo en un directorio concreto.
2. Ver si se ha producido algún error especificando el código de error mediante una constante numérica.
3. Ver el tamaño del fichero.
4. Analizar el tipo de fichero para poder, por ejemplo, aceptarlo o descartarlo, o decidir en qué carpeta dejarlo en función del tipo. (Tener encuenta que haya permisos de escritura para el usuario de apache en la carpeta donde queramos dejar el fichero)

Copiando el fichero a una carpeta

• La primera acción será copiarnos el fichero en una ubicación concreta dentro de nuestro servidor
• Lógicamente primero deberemos crear esa carpeta y asegurarnos que tenga permisos de escritura en ella el usuario apache (normalmente www-data)

chmod +w ....}}
*En el servidor tenemos el fichero disponible de forma temporal en la capeta /tmp. Podemos acceder a esta información en el elemento '''''$_FILES['tmp_name']'''''
*Para copiarlo usaremos la función '''''move_uploaded_file($origen, $destino);''''', dónde '''''$origen''''' es el fichero que queremos copiar con ubicación y $destino es la ubicación y nombre de fichero donde queremos dejarlo.
*Lo más habitual es dejar el fichero con el mismo nombre que tenía en el cliente, esta información la tenemos disponible en el atributo '''''$_FILES['name']'''''
*La función '''''move_upload(..)''' retorna un booleano que indica el éxito o fracaso de la acción. http://php.net/manual/es/function.move-uploaded-file.php.
*A continuación un resumen de estas acciones
<source lang=php>
//Suponemos en el cliente
//... <input type=file name= fichero>
//
//Accedemos al fichero que está de forma temporal en el servidor
$origen = $_FILES['fichero']['tmp_name'];
/Accedemos al nombre del fichero con el que el cliente lo subió
$nombreFichero = $_FILES['fichero']['name'];
//Establecemos la ruta donde queremos dejar el fichero
//En este caso en la carpeta del proyecto tenemos una carpeta llamada descargas con permiso de escritura para www-data
$destino ="./descargas/".$nombreFichero
//Ahora procedemos a copiar y ver el éxito o fracaso
if (move_uploaded_file($origen, $destino))
   echo ("El fichero $nombreFichero se ha subido correctamente");
else
   echo ("Error subiendo el fichero $nombreFichero");

Actividad

Vamos a realizar una práctica dónde verifiquemos el funcionamiento de todo lo visto anteriormente. Sé curiosa y comprueba los atributos comentados.

Comprobando errores

• $_FILES[error] contiene información del error que se ha podido producir al subir el fichero
• La siguiente tabla es la lista de los posibles valores que va a haber en este elemento del array superglobal $_FILES

Recursos de la Web

http://php.net/manual/es/features.file-upload.errors.php

• Un posible código para obtener esta información

//Suponemos en el cliente
//... <input type=file name= fichero>
 
$fichero = $_FILES['fichero'];
.....
$error = $fichero['error']
//Esto es igual que hacer $error = $_FILES['fichero']['error']
 
$error = $_FILES['error'];
switch ($error){
    case 0:
        echo "ERROR. Fichero subido de forma correcta. <br />";
        break;
    case 1:
        echo "ERROR. Tamaño de fichero superior al establecido en el servidor <br />"; 
 
        break;
    case 2:
        echo "ERROR. Tamaño de fichero superior al establecido en cliente<br />"; 
        echo "El tamaño se estableció en el input MAX_FILE_SIZE<br/>"; 
        echo "Tamaño establecido ".$_POST['MAX_FILE_SIZE']."<br/>";
        break;
    case 3:
        echo "ERROR. EL fichero sólo se subió parcialmente <br/>";
        break;
    case 4:
        echo "ERROR. No se subió ningún fichero <br/>";
        break;
    case 6:
        echo "ERROR. No se encuentra la carpeta temporal <br/>";
        break;
    case 7:
        echo "ERROR. No se pudo escribir en disco. revisa permisos <br/>";        
        break;
    case 8:
        echo "ERROR. Una extensión de php detuvo la subida del fichero <br/>";        
        break;
    default:
        echo "Valor de error desconocido";
}

Ver tamaño del fichero y otras directivas en php.ini

• El tamaño de fichero queda definido en el servidor por la directiva de php.ini'

upload_max_filesize=

• Otras directivas relacionadas con la descargas de ficheros están establecidas en php.ini
• A continuación se detallan con sus valores por defecto. (Ver el fichero php.ini)

;;;;;;;;;;;;;;;;
; File Uploads ;
;;;;;;;;;;;;;;;;
 
; Whether to allow HTTP file uploads.
; http://php.net/file-uploads
;Comentario: Permite la descarga de ficheros 
file_uploads = On
 
; Temporary directory for HTTP uploaded files (will use system default if not
; specified).
; http://php.net/upload-tmp-dir
;;Comentario : Establece el directorio temporal en el servidor donde se deja temporalmente el fichero subido
;;Si no se especifica se tomará /tmp en linux, o el directorio por defecto que use el SO de forma temporal
;upload_tmp_dir =
 
; Maximum allowed size for uploaded files.
; http://php.net/upload-max-filesize
;;Comentario : Tamaño máximo del fichero permitido en el servidor 
;;Se puede usar los múltiplos K M G T
upload_max_filesize = 20M
 
; Maximum number of files that can be uploaded via a single request
;;Número máximo de ficheros que se pueden descargar en una sola solicitud httlp
max_file_uploads = 20

• Podemos ver el tamaño exacto del fichero subido mediante el elemento size del array

//Suponemos en el cliente
//... <input type=file name= fichero>
....
$size = $_FILES['fichero']['size'];
....

• Entre otras cosas puede servir para descartar un fichero de menos de un tamaño concreto.

Tipo de fichero

• Este es un atributo importante

1. Analizar el tipo de fichero para poder por ejemplo aceptarlo o descartarlo o decidir en qué carpeta dejarlo en función del tipo

• Para ver el tipo podemos observar la extensión del fichero

• O bien analizar el tipo MIME que nos viene en $_FILES['type']
• Por ejemplo suponemos que queremos distribuir los ficheros en tres carpetas

1. Los ficheros que contengan imágenes a la carpeta ./descargas/imagenes/
2. Los ficheros que contengan música a la carpeta ./descargas/musica/
3. El resto de ficheros a la carpeta ./descargas/otros/

• En el tipo mime separa el tipo general del fichero con una barra.
• Así los de tipo música o audio sería audio/....'
• Así los de tipo imagen image/....'

.....

• Un posible código sería

//Suponemos en el cliente
//... <input type=file name= fichero>
 
.....
$origen = $_FILES['fichero']['tmp_name'];
$nombreFichero = $_FILES['fichero']['name'];
$tipo = $_FILES['fichero']['type'];
$tipo_fichero = explode('/', $tipo);
switch ($tipo_fichero[0]) {
    case 'audio':
        $dir_destino = "/var/www/descargas/uploads/musica";
        break;
    case 'image':
        $dir_destino = "/var/www/descargas/uploads/imagenes";
        break;
    default:
        $dir_destino = "/var/www/descargas/uploads/otros";
}
destino = $dir_destino . '/' . basename($nombreFichero);
move_uploaded_file($origen, $destino);

Trabajar con directorios

• Una vez subidos los ficheros es habitual que se quieran mostrar en la página para que el usuario los pueda ver o acceder a ellos
• Para ello, php tiene una serie de funciones que nos permite interactuar con un directorio y sus ficheros igual que si trabajáramos en un terminal.

PHP: Trabajando con ficheros y directorios

Funciones de directorio http://php.net/manual/es/ref.dir.php Funciones sobre ficheros http://php.net/manual/es/ref.filesystem.php

Ejemplo de uso de la clase Directory

• El tema de programación orientado a objetos lo veremos mas tarde, pero sabemos que para invocar a un método de un objeto se usa el operador de indirección ->
• Los métodos los vemos como funciones que son de una clase y los puede invocar un objeto. (Esta idea imprecisa de momento es suficiente).
• Directory Es una clase especializada en gestionar directorios (los directorios son ficheros igualmente)
• Para inicializarlo podemos usar un alias de new Directory() llamada dir(...)
• En su invocación pasamos el directorio que queremos ver

   $directorio = dir("/var/www/musica/subidas/");

• Para leer el contenido de un fichero o un directorio (los archivos que contiene), se usa el método read()
• Una forma de hacerlo es

 while ($archivo = $directorio -> read()){
        .................        }
 }

• Es importante cerrar el fichero (en este caso de tipo directorio), con el método close

    $directorio->close();

Recursos de la Web

Página oficial de php para la descarga de ficheros http://php.net/manual/es/features.file-upload.php Listado completo de todos los tipos MIME: https://www.sitepoint.com/web-foundations/mime-types-complete-list/ http://www.iana.org/assignments/media-types/media-types.xhtml Funciones de php para trabajar con ficheros http://www.w3schools.com/php/php_ref_filesystem.asp