python / python/cpython

zipfile.ZipInfo.from_file assumes that the archive name is a native filesystem path

Abierto
#94,533 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

OS-unsupported stdlib type-bug
Lenguaje dominante
Python
Estrellas
77.2k
Forks
36k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

Bug report

The zipfile.ZipInfo.from_file method takes a native filename, and an optional name to be placed in the archive. However, it uses a converted form of the native filename to the ZipInfo() constructor without turning it into the correct form for an archive name.

The code in question is:

https://github.com/python/cpython/blob/7db1d2eaf367a1073191c80c7baeee41ae1f2f21/Lib/zipfile.py#L526-L541

I believe that code is assuming that:

  1. ZipInfo() will know that a native filename can be converted to an archive name (this is only true on POSIX and Windows systems, see https://github.com/python/cpython/issues/94529), and so is a bad assumption
  2. A native filename is equivalent to a name that can be put into an archive. This is clearly not true on all systems.
  3. The archive name supplied will conform to the filesystem normalisation rules for the system it is running on. Again, this will not be true on filesystems that do not honour the same normalisation rules.

I believe the code should explicitly convert the filename to a form which is suitable for use as an archive name, rather than assuming that the name given is suitable.

A real world example on a system which uses a different scheme for filename separators is RISC OS, which has an os.sep of .. In such a case you might make a call to place a file in the archive with something like:

zi = ZipInfo.from_file("Application.Directory.Filename/txt")

The expectation would be that this would create a ZipInfo object with an arcname of Application/Directory/Filename.txt. However, this will actually use the arcname Application.Directory.Filename/txt - which isn't at all what was intended or useful.

I believe the code would be better handled as something like this...

        # Create ZipInfo instance to store file information
        if arcname is None:
            # The filename is still in native filename format, so we must convert to
            # the form used by the archive.
            arcname = os.path.normpath(os.path.splitdrive(filename)[1])

            # Normalise the separator to os.sep
            if os.altsep:
                arcname = arcname.replace(os.altsep, os.sep)

            # Ensure that the directory and extension separators are in arcname format
            if os.sep != '/' or os.extsep != '.':
                parts = arcname.split(os.sep)
                if os.extsep != '.':
                    parts = [part.replace(os.extsep, '.') for part in parts]
                arcname = '/'.join(parts)

        while arcname and arcname[0] == '/':
            arcname = arcname[1:]

This would...

  • Only perform the normalisation through the filesystem functions when a filename is given. That is, if you supply an arcname that's what you get, unaffected by the native platform's filesystem semantics.
  • Converts the filesystem semantics (from os.sep, os.altsep and os.extsep) to arcname semantics. We normalise from altsep to sep to simplify things, and then construct a name which uses the correct arcname convention from the known parts of the name.
  • Only performs the conversion if they would not be identity operations, so we're efficient on systems where the name is a pass through.
  • Retain the stripping of leading / characters in the archive, so that we don't create them in an odd place (although it's arguable this should be in the ZipInfo constructor to prevent overwriting system files, etc).
  • Ensure that ZipInfo is always called with a name which is an arcname, as that's what it expects anyhow (it has a little allowance for names in native form but this only ever worked on Windows and should not be relied on because on other systems it can never work, see https://github.com/python/cpython/issues/94529)
  • Retain as much of the existing behaviour as was actually reliable and deterministic as possible.

Your environment

  • CPython versions tested on: Python 3.9, Python 3.10
  • Operating system and architecture: OSX, RISC OS

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza en Lib/zipfile.py, en la implementación enlazada de ZipInfo.from_file, e inspecciona cómo los nombres de archivo nativos se convierten en nombres del archivo. Reproduce el ejemplo de RISC OS y, a continuación, verifica que un arcname ausente se convierte en separadores de archivo y sintaxis de extensión, mientras que un arcname explícito permanece sin cambios.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
backend
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.