Usuario:ManuelRomero/ProgramacionWeb/ficheros/Conceptos
Introducción
Acceso a un fichero
Entendemos por ello conseguir que php pueda actuar sobre su sistema de ficheros, es decir, en su disco duro, el disco duro que está en la máquina del servidor.
Ya vimos en la presentación que php nunca va a poder actuar sobre el disco duro del cliente (con la excepción de las cookies, como ya hemos visto, y siempre con el permiso del cliente).
Php tiene un rico abanico de funciones para realizar acciones sobre su sistema de ficheros(el del servidor), pero básicamente debemos saber realizar las típicas acciones CRUD en el sistema de ficheros (Create Read Update Delete).
- 1.-Crear un fichero o abrirlo si ya existe.
- 2.-Leer de un fichero.
- 3.-Escribir en un fichero.
- 4.-Borrar un fichero.
- Podemos ver la lista de las funciones:
http://php.net/manual/es/book.filesystem.php
Crear/Abrir un fichero para trabajar con él
- Un fichero lo podemos abrir con tres intenciones
- Leer de él.
- Escribir en él .
- Añadir en él.
Es importante a la hora de abrir un fichero saber para qué lo queremos, y abrirlo en el modo adecuado.
Para poder trabajar con el contenido del fichero tenemos la función fopen. Esta función retorna un valor resource de tipo stream, será un objeto para gestionar ficheros que es creado y administrado por funciones del sistema de php.
resource $archivo = fopen(string $nombre_fichero, string $modo)
$nombre_fichero es el nombre (se puede incluir la ruta) de fichero que queremos abrir.
|
Junto con la función fopen() que abre un recurso de tipo fichero para trabajar con él, hay que ver la función fclose(), que nos libera el recurso de memoria. Es muy importante, podríamos decir que educado y limpio, cerrar todos los recursos que hayamos abierto y ya no vayamos a utilizar, garantizaremos un buen y correcto uso de la memoria del sistema.
Esta función retornará un booleano que indicará si pudo cerrar o no el puntero al fichero
bool fclose ( resource $handle )
Parar poder acceder a un fichero necesitamos tener una referencia a él (Tanto para escribir como para leer).
- Temas de permisos de apache
A pesar de que no somos administradores/as, como ya viene siendo una práctica habitual en el curso, debemos tener conocimientos para ciertos temas. Lo primero debemos tener claro es que cuando php le dice en el script a apache que actúe sobre el sistema de ficheros, es en última instancia el usuario apache quién quiere realizar estas acciones.
- Lee atentamente el siguiente cuadro y asegúrate de tener claro cada punto, si no, pregunta.
Número | Binario | Lectura (r) | Escritura (w) | Ejecución (x) |
---|---|---|---|---|
0 | 000 | |||
1 | 001 | |||
2 | 010 | |||
3 | 011 | |||
4 | 100 | |||
5 | 101 | |||
6 | 110 | |||
7 | 111 |
Por ejemplo:
chmod 766 file.txt # brinda acceso total al dueño # y lectura y escritura a los demás chmod 770 file.txt # brinda acceso total al dueño y al grupo # y elimina todos los permisos a los demás usuarios chmod 635 file.txt # Permite lectura y escritura al dueño, # escritura y ejecución al grupo, # y lectura y ejecución al resto
(: Recuerda que es el usuario apache el que ha de tener los permisos necesarios (leer(r),escribir (w), ejecutar (x))
- Ejemplos
//Ruta relativa al directorio donde se encuentra el proyecto $archivo = fopen('log.txt',$modo); //Ruta absoluta $archivo = fopen('/var/www/html/log.txt',$modo);
- Recuerda que el $nombre_fichero Es el nombre del fichero. Nos movemos en ruta respecto a la ubiciación del script que se está ejecutando. Podemos indicar también la ruta de forma absoluta como en el ejemplos segundo
|
|
|
r | Lee un fichero desde el principio. | Se abre el fichero sólo para leer. Sitúa el cursor al principio del archivo. Si el fichero no existe o no hay permisos de lectura retorno false. |
r+ | Abre el fichero para lectura y permite la escritura. | Abre el archivo para lectura y escritura. Sitúa el cursor o puntero al principio del archivo. Si el fichero no existe o no hay permisos de lectura retorno false. |
w | Escribe un archivo y corta su contenido. | Abre el fichero sólo para escribir. Sitúa el puntero al principio y perdiéndose cualquier contenido que hubiera si existía y contenía datos. Si el archivo no existe, intenta crearlo, retornando false si no ha podido. |
w+ | Escribe un archivo desde el principio, corta su contenido, y permite la lectura. | Abre un archivo para lectura y escritura. Sitúa el puntero al principio dejando eliminando el contenido del archivo si hubiera algo. Si el archivo no existe, intenta crearlo. |
a | Abre el fichero en modo añadir . | Abierto sólo en escritura. Sitúa el puntero al final del archivo. Si el archivo no existe, intenta crearlo. |
a+ | Abre el fichero en modo lectura y añadir . | Se abre el archivo para lectura y escritura. Sitúa el puntero al final del archivo. Si el archivo no existe, intenta crearlo. |
Leer de un fichero
Una vez que hemos abierto un fichero podemos trabajar de dos formas, o bien leyendo su contenido, o bien escribiendo en él.
El modo en el que abramos el fichero deberá de ser dependiendo de la forma en la cual queremos trabajar con él. Una vez abierto en el modo adecuado vamos a proceder en este apartado, a leer de él. Si intentamos leer de un fichero que no está abierto en modo de lectura nos dará un error.
Para obtener el contenido o parte de él de un fichero debemos usar funciones de php. Entre las que vamos a usar para nuestro cometido serán de la lista siguente
string fgetc ( resource $handle )
fgets ( resource $handle [, int $length ] ):string
fread ( resource $handle , int $length ):string
file ( string $filename [, int $flags = 0 [, resource $context ]] ):array
file_get_contents ( string $filename [, bool $use_include_path = FALSE [, resource $context [, int $offset = 0 [, int $maxlen ]]]] ):string
|
https://diego.com.es/lectura-de-archivos-en-php |
http://manuel.infenlaces.com/distancia/dwes/ejercicios/
|
Como hemos visto debemos usar la función file_get_contents() retorna el contenido del fichero como un string.
Luego debemos mostrar este contenido respentando los caracteres especiales de html evitando que los interprete. Para ello usaremos la función htmlspecialchars()
Para dar un poco de sintaxis de color al código podemos usar la clase de css 'prettyprint. Debemos descargar esta clase de internet , podemos referenciarlo el js que lo carga, como podemos ver en el código aportado
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
- Vamos a hacer un ejercicio dónde si presionamos un botón mostramos el contenido del fichero
- En la primera versión lo hacemos todo sencillo según hemos estudiado
echo "<div class='fichero'>"; echo "<h2>Fichero index.php </h2>"; echo "<pre class=\"prettyprint\">".htmlspecialchars($index)."</pre>"; echo "<hr />"; echo "</div> ";
<?php $index = null; if ($_POST['submit']) { $index = file_get_contents("index.php"); } ?> <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <link rel="stylesheet" href="./estilo.css" type="text/css"> <title>Document</title> <!-- este es el script para ejecutar la clase prettypint y dar color al código funete --> <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script> </head> <body> <body> <fieldset> <legend>Presionar</legend> <form action="index.php" method ='POST'> <input type="submit" value="Ver contenido" name="submit"> </form> <?php if (!is_null($index) echo"<div class=prettyprint> htmlspecialchars($index))</div>"; ?> </fieldset> </body> </html>
Acceso a un directorio
- En realidad sería la forma que tengo de leer un directorio y acceder a todos los ficheros y directorios que tenemos.
En php tenemos diferentes formas de poder obtener este contenido, una de las más sencillas es usar la función scandir($dir), otra es crear un objeto de la clase Dir. Como aún no hemos visto objeto tomaremos la primera opción.
Esta función nos retorna un array (conjunto de elementos ordenados) con los nombres de los ficheros y directorios del directorio que pasamos como argumento.
Podemos ver el contenido del array usando la función var_dump y vemos su contenido
<?php $dir = scandir ("/var/www"); var_dump($dir); ?>
Ejecutando este código vemos el siguiente listado, que sería el listado de ficheros y directorios que tengo actualmente en la carpeta especificada
Podemos usar alguna función como ver si un archivo es o no directorio. Para ello usaremos la función is_dir($nombre_fichero) que nos dirá si es o no directorio
Tened en cuenta que he de pasar el nombre del fichero, y si no está en el directorio actual, pasaré también su ubicación.
Por ejemplo si quisiera ver solo los directorios. Claro, ahora debemos de saber cómo recorrer un array. Lo veremos en el apartado correspondiente, pero adelantamos la estructura foreach.
Esta estructura me permite recorrer un array accediendo a cada uno de sus elementos.Su sintaxis es
foreach ($array as $elemento){ echo "contenido del elemento actual $elemento"; }
- En este caso se debe de leer
recorre el array $array,hasta que llegues al final en cada iteración, lee el elemento actual(el contenido y
guárdalo en la variable $elemento en la siguiente iteración leerá el elementos siguiente así hasta que llegue al final
<?php $base = "/var/www/"; $dir = scandir($base); echo "<ol>"; //Creo una lista ordenada para que html los numere foreach ($dir as $fichero) { //Muestro el elemento del array echo "<li>$fichero</li>"; } ?>
?>
- Veremos como salida
- Seguimo profundizando en este ejemplo, imaginemos que solo queremos mostrar aquello ficheros que sean directorios. Para ello usaremos la función is_dir() y además no mostrar el directorio actual . y el directorio del que vengo ..' (punto y punto punto respectivaemnte)
<?php <?php $base = "/var/www/"; $dir = scandir($base); echo "<ol>"; foreach ($dir as $fichero) { //Observa que le paso la concatenación del directorio base y el fichero leído if (is_dir("$base$fichero")) { if ($fichero != "." && $fichero != "..") { echo "<li>$fichero</li>"; } } } echo "</li>"; ?>
- Podemos ver la salida
- Para terminar supongamos que queremos tener una lista de nuestros proyectos. Por proyectos entendemos los directorios que tengamos en nuestro documentroot en cuyo contenido tengamos un index.php
Para ello debemos ver si dentro de cada directorio existe un fichero llamado index.php. De ser así querremos mostrar ese directorio. Además querremos mostrarlo con una ancla <a> , de modo que al presionar sobre ese texto se ejecute el fichero index de ese proyecto.
Para este cometido nos falta la función que nos diga si un fichero existe o no. Esto lo podemos conseguir usando la función file_exists($dir), que nos devolverá un booleano con dicha información (si existe true, si no, false).
<?php $base = "/var/www/"; $dir = scandir($base); foreach ($dir as $directorio) { if (is_dir("$base$directorio")) { if ($directorio != "." && $directorio != "..") { if (file_exists("$base$directorio/index.php")) { $lista .= "<li><a href=$directorio/index.php>$directorio</a></li>"; } } } } echo "<ol>$lista</li>"; ?>
- Podemos ver el resultado en la siguiente imagen
Escribir en un fichero
- Ahora vamos a ver cómo escribir en un fichero. Para ello usaremos la función fwrite()
fwrite ( resource $handle , string $string [, int $length ] ):int
Esta función debe recibir obligatoriamente dos parámetros
- $handle es una referencia al fichero abierto, el valor que retorno fopen
- $string es la cadena que queremos escribir en el fichero
Por supuesto el fichero debe de estar abierto en modo de escritura, si no, no se podrá realizar la operación.
- El valor entero que retorna será el número de bytes escritos
fwrite($fichero, "texto para escribir");
- Vamos a hacer un ejemplo que genere un fichero llamado log.txt que contenga información de acciones
Es muy típico en nuestros proyectos que llevemos un log, anotando lo que se va escribiendo. Vamos a anotar la hora y un texto cualquiera
<?php /** * Created by PhpStorm. * User: manuel * Date: 21/11/18 * Time: 11:01 */ $file = fopen ("log.txt", "w"); $texto = date("Y-m-d H:i:s") ." Agregando contendios al fichero \n"; fwrite($file, $texto); fclose($file); ?>
- En esta caso cada vez que ejecutemos el script perderemos el contenido que tuviéramos en el fichero
- Si queremos conservarlo debemos abrir en el modo añadir
<?php /** * Created by PhpStorm. * User: manuel * Date: 21/11/18 * Time: 11:01 */ $file = fopen ("log.txt", "a"); $texto = date("Y-m-d H:i:s") ." Agregando contendios al fichero \n"; fwrite($file, $texto); fclose($file); ?>
Otras acciones (borrar y copiar/mover)
- Borrar un fichero
Son muchas las acciones que podemos realizar con los ficheros, podemos ver la lista en la web oficial de php.
Vamos a ver dos que son importantes, siguiendo con el ejemplo anterior, si el fichero log creciera y creciera, se puede volver muy grando. La idea es que si ocupa de de un determinado espacio lo borramos. Para ello usaremos la función unlink()
- Supongamos que si el fichero mide más de 1kbyte lo queremos borrar
<?php /** * Created by PhpStorm. * User: manuel * Date: 21/11/18 * Time: 11:01 */ $file = fopen ("log.txt", "a"); $texto = date("Y-m-d H:i:s") ." Agregando contendios al fichero \n"; fwrite($file, $texto); $size= filesize("log.txt"); echo "valor del tamaño $size<br />"; if ($size > 1024) { unlink("log.txt"); echo "El fichero ha sido borrado"; } fclose($file); ?>
- Si ejecutamos el fichero cada vez que escribimos, escribimos 53 bytes. Después de ejecutarlo 20 veces se borra el fichero
- Copiar/mover un fichero
- Puede ser que en un momento dado queramos copiar un fichero
- Para ello, usaremos el método rename(), que lo que hace es mover un fichero
bool rename ( string $oldname , string $newname [, resource $context ] )
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 valor a este atributo, 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.
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="index.php" 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 a MAX_SIZE_FILE y value el valor del tamaño máximo en bytes.
.... <form action="index.php" method="POST" entype='multipart/form-data'> <input type=hidden name ="MAX_SIZE_FILE" value=10000000> <input type=file name=fichero> .... </form>
- Este mecanismo no envía nada al servidor, dejará de enviar el fichero al servidor .
- 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 como 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 almacenada en 5 componentes:
- name Nombre del fichero en el cliente
- type Tupo de fichero subido
- size Tamaño en bytes del fichero
- tpm_name Nombre asignado de forma temporal en el servidor
- 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:
- Capturar el fichero y dejarlo en un directorio concreto.
- Ver si se ha producido algún error especificando el código de error mediante una constante numérica.
- Ver el tamaño del fichero.
- Analizar el tipo de fichero para poder, por ejemplo, aceptarlo o descartarlo, o decidir en qué carpeta dejarlo en función del tipo. (Tener en cuenta que haya permisos de escritura para el usuario de apache (www-data) 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)
- 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
//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");
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
Valor entero | Constante | Descripción |
---|---|---|
0 | UPLOAD_ERR_OK | Fichero subido exitosamente |
1 | UPLOAD_ERR_INI_SIZE | Tamaño excedido según directiva upload_max_filesize de php.ini. |
2 | UPLOAD_ERR_FORM_SIZE | El fichero subido excede la directiva MAX_FILE_SIZE especificada en el formulario HTML. |
3 | UPLOAD_ERR_PARTIAL | El fichero fue sólo parcialmente subido. |
4 | UPLOAD_ERR_NO_FILE | No se subió ningún fichero. |
6 | UPLOAD_ERR_NO_TMP_DIR | Falta la carpeta temporal. |
7 | UPLOAD_ERR_CANT_WRITE | No se pudo escribir el fichero en el disco. |
8 | UPLOAD_ERR_EXTENSION | Una extensión de PHP detuvo la subida de ficheros. |
- 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
- 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
- Los ficheros que contengan imágenes a la carpeta ./descargas/imagenes/
- Los ficheros que contengan música a la carpeta ./descargas/musica/
- 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);
Esta función rompe una cadena de caracteres en diferentes campos de un array indexado cada vez que encuentre un determinado carácter. Tango el carácter, como la cadena son argumentos pasados a la función. http://php.net/manual/es/function.explode.php