File: sanitizefilename.cc

package info (click to toggle)
signalbackup-tools 20250313.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 3,752 kB
  • sloc: cpp: 47,042; sh: 477; ansic: 399; ruby: 19; makefile: 3
file content (88 lines) | stat: -rw-r--r-- 2,707 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/*
  Copyright (C) 2021-2024  Selwin van Dijk

  This file is part of signalbackup-tools.

  signalbackup-tools is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  signalbackup-tools is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with signalbackup-tools.  If not, see <https://www.gnu.org/licenses/>.
*/

#include "signalbackup.ih"

std::string SignalBackup::sanitizeFilename(std::string const &filename) const
{
  std::string result;

#if !defined(_WIN32) && !defined(__MINGW64__)

  // filter disallowed characters. (Note this is not an exact science)
  for (char c : filename)
    result += ((c == '/' || c == '\0' || c == '\n') ? '_' : c); // newline is technically allowed I think

#else // WINDOWS, NOT TESTED

  auto icasecmp = [](char a, char b)
  {
    return ((a == b) || (tolower(static_cast<unsigned char>(a)) == tolower(static_cast<unsigned char>(b))));
  };

  std::vector<std::string> const reserved =
    {
      "CON",
      "PRN",
      "AUX",
      "CLOCK$",
      "NUL",
      "COM0", "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9",
      "LPT0", "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9",
      /* these are ntfs things, best just not allow them.... */
      "$Mft",
      "$MftMirr",
      "$LogFile",
      "$Volume",
      "$AttrDef",
      "$Bitmap",
      "$Boot",
      "$BadClus",
      "$Secure",
      "$Upcase",
      "$Extend",
      "$Quota",
      "$ObjId",
      "$Reparse",
    };

  // filter reserved filenames
  for (auto const &r : reserved)
    if (filename.size() == r.size() &&
        std::equal(filename.begin(), filename.end(),
                   r.begin(), r.end(), icasecmp))
      return "_" + filename;

  // filter disallowed characters. (Note this is not an exact science)
  for (char c : filename)
    result += ((c == '/' || c == '\\' || c == '?' ||
                c == '*' || c == ':' || c == '|' ||
                c == '"' || c == '<' || c == '>' ||
                c <= 0x1f || c == 0x7f) ? '_' : c);

  // trailing whitespace or periods are (possibly) technically allowed
  // by the filesystem, but not supported by windows shell and UI
  while (result.back() == ' ' ||
         result.back() == '.')
    result.pop_back();

#endif

  return result;
}