Utilizar Archivos PharUtilizar Archivos Phar: Introduction
Los archivos phar son similares en concepto a los archivo JAR de Java, pero están adaptados
a las necesidades y a la flexibilidad de apliciones de PHP. Un archivo Phar se
usa para distribuir una aplicación o biblioteca PHP completa en un único fichero. Una
aplicación de un archivo Phar se utiliza exactamente de la misma manera que otra aplicación PHP:
Utilizar una biblioteca de archivo Phar es idéntico a usar cualquier otra biblioteca de PHP:
]]>
La envoltura de flujos phar proporciona el núcleo de la extensión Phar, y
está explicada en detalle aquí.
La envoltura de flujos phar permite el acceso a los ficheros dentro de un archivo phar utilizando
las funciones estándar de ficheros de PHP fopen, opendir, y
y otras que trabajan sobre ficheros normales. La envoltura de flujos phar soporta todas
las operaciones de lectura/escritura tanto en ficheros como en directorios.
]]>
La clase Phar implementa una funcionalidad avanzada para acceder
a ficheros y crear arhivos phar. La clas Phar está explicada en detalle
aquí.
getFileName() . "\n";
echo file_get_contents($fichero->getPathName()) . "\n"; // mostrar el contenido;
}
if (isset($p['fichero/interno.php'])) {
var_dump($p['fichero/interno.php']->getMetadata());
}
// crear un nuevo phar - phar.readonly debe ser 0 en php.ini
// phar.readonly está habilitado por omisión por motivos de seguridad.
// En servidores de producción, los archivos Phar nunca se crean,
// sólo se ejecutan.
if (Phar::canWrite()) {
$p = new Phar('nuevo_phar.tar.phar', 0, 'nuevo_phar.tar.phar');
// hacerlo un archivo phar basado en tar, comprimido con gzip (.tar.gz)
$p = $p->convertToExecutable(Phar::TAR, Phar::GZ);
// crear una transacción - no se escribe nada en nuevo_phar.phar
// hasta que stopBuffering() sea llamado, aunque se necesita almacenamiento temporal
$p->startBuffering();
// añadir todos los ficheros de /ruta/del/proyecto, guardándolos en el phar con el prefijo "proyecto"
$p->buildFromIterator(new RecursiveIteratorIterator(new DirectoryIterator('/ruta/del/proyecto')), '/ruta/del/');
// añadir un nuevo fichero mediante la API de acceso a arrays
$p['fichero1.txt'] = 'Información';
$fp = fopen('fichero_enorme.dat', 'rb');
// copiar toda la información del flujo
$p['datos/fichero_enorme.dat'] = $fp;
if (Phar::canCompress(Phar::GZ)) {
$p['datos/fichero_enorme.dat']->compress(Phar::GZ);
}
$p['imagenes/wow.jpg'] = file_get_contents('imagenes/wow.jpg');
// cualquier valor se puede guardar como metainformación específica del fichero
$p['imagenes/wow.jpg']->setMetadata(array('mime-type' => 'image/jpeg'));
$p['index.php'] = file_get_contents('index.php');
$p->setMetadata(array('bootstrap' => 'index.php'));
// cuardar el archivo phar en el disco
$p->stopBuffering();
}
} catch (Exception $e) {
echo 'No se pudo abrir Phar: ', $e;
}
?>
]]>
Además, la verificación del contenido de ficheros phar se puede realizar utilizando cualquiera de los
algoritmos hash simétricos soportados (MD5, SHA1, SHA256 y SHA512 si la extensión Hash está habilitada)
y utilizando firmas de clave pública/privada asimétricas de OpenSSL (nuevo en Phar 2.0.0). Para
aprovechar la firmas de OpenSSL, se necesita generar una pareja de claves pública/privada, y
utilizar la clave privada para establecer la firma usando
Phar::setSignatureAlgorithm. Además, la clave pública se
extrae usando este código:
]]>
debe ser guardada junto al archivo phar que verifica. Si el archivo phar
es guardado como /ruta/a/mi.phar, la clave pública debe guardarse
como /ruta/a/mi.phar.pubkey, o phar no será capaz de verificar
la firma OpenSSL.
A partir de la verisón 2.0.0, la clase Phar también proporciona tres métodos estáticos, Phar::webPhar,
Phar::mungServer y Phar::interceptFileFuncs, los cuales son cruiciales
para empaquetar aplicaciones PHP diseñadas para un uso en sistemas de ficheros normales y aplicación basadas en web.
Phar::webPhar implementa un controlador principal que direcciona llamadas HTTP a la ubicación
correcta dentro del archivo phar. Phar::mungServer se utiliza para modificar los valores del
array $_SERVER para hacer que las aplicaciones procesen estos valores.
Phar::interceptFileFuncs ordena a Phar que intercepte llamdas a
fopen, file_get_contents, opendir, y
a todas las funciones basadas en estadísticas (file_exists, is_readable, etc.) y
direccione todas las rutas relativas a las ubicaciones dentro del archivo phar.
Como ejemplo, empaquetar una versión de la popular aplicación phpMyAdmin para usarla cono un archivo phar, requiere
solamente este sencillo script, y después se puede acceder a phpMyAdmin.phar.tar.php como un fichero normal
desde el servidor web después de modificar el usuario/contraseña:
startBuffering();
$a["phpMyAdmin-2.11.3-english/config.inc.php"] = 'setStub('stopBuffering();
?>
]]>
Utilizar Archivos Phar: la envoltura de flujos phar
La envoltura de flujos phar soporta completamente fopen para
leer y escribir (no añadir), unlink, stat,
fstat, fseek, rename
y operaciones de flujo de directorios opendir y a partir de la versión 2.0.0, rmdir
y mkdir.
También se pueden manipular compresiones de ficheros individuales y metadatos por fichero
en un archivo Phar usando contextos de flujo:
array('compress' => Phar::GZ)),
array('metadata' => array('user' => 'cellog')));
file_put_contents('phar://mi.phar/fichero.php', 0, $contexto);
?>
]]>
La envoltura de flujos phar no opera sobre ficheros remotos,
y no puede operar sobre ficheros remotos, and cannot operate on remote files, and so is allowed even when the
allow_url_fopen and
allow_url_include INI options
are disabled.
Aunque es posible crear archivos phar desde cero simplemente usando
operaciones de flujos, es mejor utilizar la funcionalidad interna
de la clase Phar. La envoltura de flujos se usa mejor para operaciones de sólo lectura.
Utilizar Archivos Phar: las clases Phar y PharData
La clase Phar admite la lectura y la manipulación
de archivos Phar, así como la iteración a través de la funcionalidad de
la clase RecursiveDirectoryIterator.
Con el soporte para la interfaz ArrayAccess,
se puede acceder a los ficheros que están dentro de un archivo Phar como si fueran
parte de un array asociativo.
La clase PharData extiende la clase Phar, y
permite crear y modificar archivos tar y zip no ejecutables (datos) incluso si
phar.readonly=1 en php.ini. Por lo tanto,
PharData::setAlias y PharData::setStub
están desactivados ya que los conceptos de alias y rutina de interoperabilidad (stub) son válidos únicamente para archivos
phar ejecutables.
Observe que al crear un archivo Phar, se debería pasar la
ruta completa al contructor del objeto de la clase Phar.
Las rutas relativas causarán un error en la inicialización.
Asumiendo que $p es un objeto de la clase Phar inicializado como sigue:
]]>
se creará un archivo Phar vacío en /ruta/a/miphar.phar,
o si /ruta/a/miphar.phar ya existe, se abrirá
de nuevo. El literal miphar.phar demuestra el concepto de un alias
que puede ser usado para referenciar a /ruta/a/miphar.phar en URLs, como en:
]]>
Con el recién creado objeto $p de la clase Phar,
lo siguiente es posible:
$a = $p['fichero.php'] creates a PharFileInfo
class that refers to the contents of phar://miphar.phar/fichero.php$p['fichero.php'] = $v crea un nuevo fichero
(phar://miphar.phar/fichero.php), o sobrescribe
un fichero existente dentro de miphar.phar. $v
puede ser una cadena o un puntero de fichero abierto, en cuyo caso todo el
contenido del fichero se usará para crear el nuevo fichero. Observe que
$p->addFromString('fichero.php', $v) es funcionalmente
equivalente a lo de más arriba. También es posible añadir el contenido de un fichero
con $p->addFile('/path/to/fichero.php', 'fichero.php').
Por ultimo, se puede crear un directorio vacío con
$p->addEmptyDir('vacio').
isset($p['fichero.php']) se puede usar para determinar
si phar://miphar.phar/fichero.php existe dentro de
miphar.phar.
unset($p['fichero.php']) borra
phar://miphar.phar/fichero.php de
miphar.phar.
Además, el objeto de la clase Phar es la única manera de acceder
a metainformación específica de Phar, a través de
Phar::getMetadata,
y la única manera de establecer o recuperar una rutina de interoperabilidad (stub) del cargador de PHP de un archivo Phar a través de
Phar::getStub y
Phar::setStub.
Además, la compresión del archivo completo Phar de una vez, sólo puede ser manipulada
utilizando la clase Phar.
La lista completa de la funcionalidad de objetos de la clase Phar está documentada
más adelante.
La clase PharFileInfo extiende a la
clase SplFileInfo,
y añade varios métodos para manipular detalles específicos de Phar de un fichero
contenido en un Phar, tales como la manipulación de la compresión y la metainformación.