mirror of
https://github.com/git/git
synced 2024-08-25 10:45:59 +00:00
![Torsten Bögershausen](/assets/img/avatar_default.png)
Mac OS X mangles file names containing unicode on file systems HFS+, VFAT or SAMBA. When a file using unicode code points outside ASCII is created on a HFS+ drive, the file name is converted into decomposed unicode and written to disk. No conversion is done if the file name is already decomposed unicode. Calling open("\xc3\x84", ...) with a precomposed "Ä" yields the same result as open("\x41\xcc\x88",...) with a decomposed "Ä". As a consequence, readdir() returns the file names in decomposed unicode, even if the user expects precomposed unicode. Unlike on HFS+, Mac OS X stores files on a VFAT drive (e.g. an USB drive) in precomposed unicode, but readdir() still returns file names in decomposed unicode. When a git repository is stored on a network share using SAMBA, file names are send over the wire and written to disk on the remote system in precomposed unicode, but Mac OS X readdir() returns decomposed unicode to be compatible with its behaviour on HFS+ and VFAT. The unicode decomposition causes many problems: - The names "git add" and other commands get from the end user may often be precomposed form (the decomposed form is not easily input from the keyboard), but when the commands read from the filesystem to see what it is going to update the index with already is on the filesystem, readdir() will give decomposed form, which is different. - Similarly "git log", "git mv" and all other commands that need to compare pathnames found on the command line (often but not always precomposed form; a command line input resulting from globbing may be in decomposed) with pathnames found in the tree objects (should be precomposed form to be compatible with other systems and for consistency in general). - The same for names stored in the index, which should be precomposed, that may need to be compared with the names read from readdir(). NFS mounted from Linux is fully transparent and does not suffer from the above. As Mac OS X treats precomposed and decomposed file names as equal, we can - wrap readdir() on Mac OS X to return the precomposed form, and - normalize decomposed form given from the command line also to the precomposed form, to ensure that all pathnames used in Git are always in the precomposed form. This behaviour can be requested by setting "core.precomposedunicode" configuration variable to true. The code in compat/precomposed_utf8.c implements basically 4 new functions: precomposed_utf8_opendir(), precomposed_utf8_readdir(), precomposed_utf8_closedir() and precompose_argv(). The first three are to wrap opendir(3), readdir(3), and closedir(3) functions. The argv[] conversion allows to use the TAB filename completion done by the shell on command line. It tolerates other tools which use readdir() to feed decomposed file names into git. When creating a new git repository with "git init" or "git clone", "core.precomposedunicode" will be set "false". The user needs to activate this feature manually. She typically sets core.precomposedunicode to "true" on HFS and VFAT, or file systems mounted via SAMBA. Helped-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Torsten Bögershausen <tboegi@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
46 lines
1.3 KiB
C
46 lines
1.3 KiB
C
#ifndef PRECOMPOSE_UNICODE_H
|
|
#include <sys/stat.h>
|
|
#include <sys/types.h>
|
|
#include <dirent.h>
|
|
#include <iconv.h>
|
|
|
|
|
|
typedef struct dirent_prec_psx {
|
|
ino_t d_ino; /* Posix */
|
|
size_t max_name_len; /* See below */
|
|
unsigned char d_type; /* available on all systems git runs on */
|
|
|
|
/*
|
|
* See http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/dirent.h.html
|
|
* NAME_MAX + 1 should be enough, but some systems have
|
|
* NAME_MAX=255 and strlen(d_name) may return 508 or 510
|
|
* Solution: allocate more when needed, see precompose_utf8_readdir()
|
|
*/
|
|
char d_name[NAME_MAX+1];
|
|
} dirent_prec_psx;
|
|
|
|
|
|
typedef struct {
|
|
iconv_t ic_precompose;
|
|
DIR *dirp;
|
|
struct dirent_prec_psx *dirent_nfc;
|
|
} PREC_DIR;
|
|
|
|
void precompose_argv(int argc, const char **argv);
|
|
void probe_utf8_pathname_composition(char *, int);
|
|
|
|
PREC_DIR *precompose_utf8_opendir(const char *dirname);
|
|
struct dirent_prec_psx *precompose_utf8_readdir(PREC_DIR *dirp);
|
|
int precompose_utf8_closedir(PREC_DIR *dirp);
|
|
|
|
#ifndef PRECOMPOSE_UNICODE_C
|
|
#define dirent dirent_prec_psx
|
|
#define opendir(n) precompose_utf8_opendir(n)
|
|
#define readdir(d) precompose_utf8_readdir(d)
|
|
#define closedir(d) precompose_utf8_closedir(d)
|
|
#define DIR PREC_DIR
|
|
#endif /* PRECOMPOSE_UNICODE_C */
|
|
|
|
#define PRECOMPOSE_UNICODE_H
|
|
#endif /* PRECOMPOSE_UNICODE_H */
|