Namefix

Fix bad filenames - tries to rename files so all characters are ASCII, replaces spaces with an underscore and periods with a hypen, replaces all other non-ASCII characters with a question mark and keeps extension untouched, all of that configurable through bunch of options.

Examples

So m.a.n.y d.o.t.s.thing -> So_m-a-n-y_d.o.t.s.thing

Ṱ̺̺̕o͞ ̷i̲̬͇̪͙n̝̗͕v̟̜̘̦͟o̶̙̰̠kè͚̮̺̪̹̱̤ ̖t̝͕̳̣̻̪͞h̼͓̲̦̳̘̲e͇̣̰̦̬͎ ̢̼̻̱̘h͚͎͙̜̣̲ͅi̦̲̣̰̤v̻͍e̺̭̳̪̰-m̢iͅn̖̺̞̲̯̰d̵̼̟͙̩̼̘̳.thing -> To_?invoke_?the_?hive-mind.thing

Žluťoučký kůň.thing -> Zlutoucky_kun.thing

Ω§E®Ŧ¥↑ıØÞÆẞЪŊĦŁß©×.thing -> O?E(R)T?iOTHAESSD?NHLss(C)*.thing

Привет.thing -> Privet.thing

Usage

namefix {OPTIONS} [input...]

OPTIONS:

  -v, --verbose                     Verbose output
  -V, --verbose-long                Verbose output - absolute paths
  -r, --report                      Just report all files not conforming, -V
                                    for absolute paths
  -d, --dry-run                     Dry run, don't do anything, just print
                                    what would have been done (implies -v)
  -I, --ignore-errors               Do not stop when error is encountered
  -e[NUM], --extensions=[NUM]       Set maximum number of extensions (that
                                    will be untouchted) - default 4
  -D, --no-directory                Ignore directories
  -Y, --no-symlinks                 Ignore symlinks
  -F, --force                       Force overwrite even if file exists
  -s[STR], --spaces=[STR]           Replace spaces with STR
  -S, --no-spaces                   Do not replace spaces - default
                                    replacement is '_'
  -p[STR], --periods=[STR]          Replace periods with STR
  -P, --no-periods                  Do not replace periods - default
                                    replacement is '-'
  -n[STR], --non-ASCII=[STR]        Replace remaining non-ASCII characters
                                    with STR - default replacement is '?'
  -c[NUM], --characters=[NUM]       The maximum length for the new filename
                                    (without extension!) default is 64
  -o[A/B], --override=[A/B]         Replace A with B before fixing filename
  -O[A/B],
  --exclusive-override=[A/B]        Only replace A with B, change nothing
                                    else
  -k[PATH], --keep-path=[PATH]      Do not rename, make a copy with new name
                                    and put it in PATH
  -K, --keep                        Do not rename, make a copy with new name
  -t[STR], --to-ASCII=[STR]         Test a string - transforms a UTF-8
                                    string into ASCII and prints it, does
                                    not keep extension
  --version                         Outputs the version
  -h, --help                        Display this help menu

  input...                          Input files
  "--" can be used to terminate flag options and force all following
  arguments to be treated as positional options

Installation

PKGBUILD is now available in AUR!

Get it manually or use your AUR helper i.e.:

yay -S namefix

I plan to make an Arch PKGBUILD and also a Debian package sometime in the future.

Known Bugs & Caveats

• does not have any advanced logic detecting multiple extensions, uses system std::filesystem::path::stem() - look at option -e for maximum number of extensions cut off before name-fixing begins

Building from source

You will need to have make, strip (binutils), git and g++ (gcc). Than it should be as simple as cloning this repo and running make. A namefix executable will be generated, place it wherever you like. You can run make install if you want to copy the executable to /usr/local/bin/, and make uninstall runs rm /usr/local/bin/namefix if you want to remove it.

	git clone https://github.com/sukulent/namefix.git && cd namefix

	make

	sudo make install

How is it done?

Firstly, these flags are checked:

• If help flag is set, show help and exit.
• If version flag is set, show version and exit.
• If to-ASCII flag is set, convert the provided string to ASCII and exit. Does not replace spaces or periods.

Than for each file provided:

• Fail if the file does not exist (if ignore-errors flag is not set)
• Separate extensions
• If any override flag is set, replace accordingly.
• If exclusive-override flag is set, skip this, otherwise:
  • convert to ASCII
  • resize if bigger than character flag
  • if no-spaces flag is not set, replace spaces
  • if no-periods flag is not set, replace periods
• The new path is constructed from original, new filename and original extensions
• If report flag is set, print the file if new path differs from original, print absolute paths if --verbose-long flag is set, continue to next file.
• If any verbose flag is set, print info and if original path and new path are the same, continue to next file.
• If dry-run flag is set, skip this, otherwise:
  • If any keep flag is set, copy the file (if it fails, and ignore-errors not set, exit)
  • Else rename the file (if it fails, and ignore-errors not set, exit)
• If all files were processed
  • and ignore-errors flag is set and errors happend, print how many there were, otherwise
• Exit.

ASCII Conversion

I am using the unicode library for the conversion to ASCII. It is done in these steps:

• normalize into fully decomposed form
• normalize into fully composed form
• transliterate from Any into Latin
• transliterate again from Any into ASCII
• check for all remaining non-ASCII characters and replace them with '?' (or as specified)
• resize the name
• replace spaces
• replace periods

Other

Currently, I think of this project as complete, but I may revisit it sometime in the future. I will try to fix bugs, so feel free to open an issue if you found any. The same goes for feature requests, feel free to open an issue and if it catches my eye, I might implement it.

Using the args library for argument parsing.

License

This program is lincesed under the GPL-3-or-later license.