Plantilla:PHP/Formularios/accionesFicheros

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

http://php.net/manual/es/language.types.resource.php

fopen

resource $archivo = fopen(string $nombre_fichero, string $modo) Esta función retorna un descriptor de fichero (un objeto de tipo recurso stream) $nombre_fichero es el nombre (se puede incluir la ruta) de fichero que queremos abrir. $modo es el modo de apertura (lectura, creación, añadir )· Hay varios modos como podemos ver en la tabla de más abajo, si bien los podemos clasificar en tres grupos r => Lectura. Abre el fichero para leer, si no existe da un error w => Escritura (Trunca el contenido). Abre el fichero para escribir, Si no existe el fichero lo intenta crear, si existe se borrará su contenido a => append o añadir. Abre el fichero para añadir en él Si no existe el fichero lo intenta crear, si existe se pondrá el puntero al final des fichero para escribir (respetando lo que hubiera escrito).

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.

Puntos fundamentales sobre permisos

1.- En linux todo fichero tiene un propietario, y también todo proceso. El propietario del proceso es el usuario que lazó dicho proceso. Cuando un proceso quiere hacer algo sobre un fichero, el usuario que lanzó el proceso, debe tener permisos sobre el fichero para hacerlo. El usuario que lanza apache es www-data Para hacer a un usuario propietario de un fichero o a su grupo usamos la sentencia sudo chown usuario:grupo fichero (-R) }} (: *-R parámetro opcional que actuaría de forma recursiva. En php un directorio es igual que un fichero cuyo contenido son los ficheros y directorios que contiene.) Para dar permisos sobre un fichero a un usuario usamos la sentencia sudo chmod permisos fichero (-R) }} (: permisos' es un número de tres dígitos en octal, ver tabla de abajo. fichero al cual le queremos dar permisos, se puede usar * para especificar todos. -R parámetro opcional que actuaría de forma recursiva. )

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

Parámetro	Acción	Descripción
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

funciones de lectura

fgetc() - Obtiene un carácter de un puntero a un archivo string fgetc ( resource $handle ) fgets() — Obtiene una línea desde el puntero a un fichero fgets ( resource $handle [, int $length ] ):string fread() - Lectura de un fichero en modo binario seguro fread ( resource $handle , int $length ):string Leemos de un fichero la longuitd en bytes que indique el segundo parámetro En este caso la lectura es en un fichero binario. file() — Transfiere un fichero completo a un array file ( string $filename [, int $flags = 0 [, resource $context ]] ):array Obtenemos en un array todo el contenido de un fichero El criterio para separar los campos es el salto de línea Tendremos tantos elementos como líneas tenga el fichero file_get_contents() — Transmite un fichero completo a una cadena file_get_contents ( string $filename [, bool $use_include_path = FALSE [, resource $context [, int $offset = 0 [, int $maxlen ]]]] ):string Como resultado tendré un string con todo el contenido del fichero Observa que en este caso, no necesitamos pasar el descriptor del fichero , sino su nombre (y ruta si no es relativo al proyecto)

Recursos de la Web

Lectura de ficheros https://diego.com.es/lectura-de-archivos-en-php

Actividad

Escribe un fichero de texto con 20 nombres llamado "nombres.txt" y léelo usando las funciones anteriores Cada vez que uses una nueva forma cierra y vuelve a abrir el fichero Haz que alguna línea tenga etiquetas html para ver la funcionalidad de la función fgetss() Posible contenido de nombres.txt Manuel Romero <h6>Luis javier Ruiz</h6> Elena Rubio<br /> Nieves López <span style=strong>Lourdes Jimenez</span> Prueba la ejecución, los fuentes disponibles en ejercicios en la sección de ficheros http://manuel.infenlaces.com/distancia/dwes/ejercicios/

Actividad

Haz un programa que muestre el contenido del fichero que estás ejecutando

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 &lta&gt , 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 ] )