用于文件名的字符串清理程序

时间:2010-01-07 15:58:26

标签: php string sanitization

我正在寻找一个能够清理字符串并准备好用于文件名的php函数。谁知道一个方便的?

(我可以写一个,但我担心我会忽视一个角色!)

编辑:用于保存Windows NTFS文件系统上的文件。

17 个答案:

答案 0 :(得分:134)

对Tor Valamo解决方案进行小幅调整以解决Dominic Rodger注意到的问题,可以使用:

// Remove anything which isn't a word, whitespace, number
// or any of the following caracters -_~,;[]().
// If you don't need to handle multi-byte characters
// you can use preg_replace rather than mb_ereg_replace
// Thanks @Łukasz Rysiak!
$file = mb_ereg_replace("([^\w\s\d\-_~,;\[\]\(\).])", '', $file);
// Remove any runs of periods (thanks falstro!)
$file = mb_ereg_replace("([\.]{2,})", '', $file);

答案 1 :(得分:37)

使用rawurlencode()怎么样? http://www.php.net/manual/en/function.rawurlencode.php

这个功能甚至可以消毒中国的Chars:

public static function normalizeString ($str = '')
{
    $str = strip_tags($str); 
    $str = preg_replace('/[\r\n\t ]+/', ' ', $str);
    $str = preg_replace('/[\"\*\/\:\<\>\?\'\|]+/', ' ', $str);
    $str = strtolower($str);
    $str = html_entity_decode( $str, ENT_QUOTES, "utf-8" );
    $str = htmlentities($str, ENT_QUOTES, "utf-8");
    $str = preg_replace("/(&)([a-z])([a-z]+;)/i", '$2', $str);
    $str = str_replace(' ', '-', $str);
    $str = rawurlencode($str);
    $str = str_replace('%', '-', $str);
    return $str;
}

这是解释

  1. 剥离HTML标记
  2. 删除中断/标签/返回广告
  3. 删除文件夹和文件名
  4. 的非法字符
  5. 将字符串放在小写字母
  6. 删除Éàû等外国口音,将其转换为html实体,然后删除代码并保留字母。
  7. 用短划线替换空格
  8. 对可以通过前面步骤的特殊字符进行编码,并在服务器上输入冲突文件名。恩。 “中文百强网”
  9. 用短划线替换“%”,以确保在查询文件时浏览器不会重写文件的链接。
  10. 好的,一些文件名不会重新发布,但在大多数情况下它会起作用。

    离。 原名:“საბეჭდი-და-ტიპოგრაფიული.jpg”

    输出名称:“ - E1-83-A1-E1-83-90-E1-83-91-E1-83-94-E1-83-AD-E1-83-93-E1-83-98- -E1-83-93-E1-83-90 - E1-83-A2-E1-83-98-E1-83-9E-E1-83-9D-E1-83-92-E1-83-A0〜 E1-83-90-E1-83-A4-E1-83-98-E1-83-A3-E1-83-9A-E1-83-98.jpg“

    这比404错误更好。

    希望这很有用。

    卡尔。

答案 2 :(得分:32)

不要担心忽视角色 - 如何使用角色白名单,您会乐意使用它吗?例如,您可以只允许“a-z0-9_以及句点(.)的单个实例。这显然比大多数文件系统更具限制性,但应该保证您的安全。

答案 3 :(得分:27)

解决方案1 ​​ - 简单有效

$file_name = preg_replace( '/[^a-z0-9]+/', '-', strtolower( $url ) );

  • strtolower()保证文件名是小写的(因为大小写在URL内部无关紧要,但在NTFS文件名中)
  • [^a-z0-9]+将确保文件名仅保留字母和数字
  • '-'替换无效字符可保持文件名可读

示例:

URL:  http://stackoverflow.com/questions/2021624/string-sanitizer-for-filename
File: http-stackoverflow-com-questions-2021624-string-sanitizer-for-filename

解决方案2 - 对于很长的网址

您希望缓存网址内容,只需要拥有唯一的文件名即可。 我会用这个函数:

$file_name = md5( strtolower( $url ) )

这将创建一个固定长度的文件名。在大多数情况下,MD5哈希足以满足此类用途。

示例:

URL:  https://www.amazon.com/Interstellar-Matthew-McConaughey/dp/B00TU9UFTS/ref=s9_nwrsa_gw_g318_i10_r?_encoding=UTF8&fpl=fresh&pf_rd_m=ATVPDKIKX0DER&pf_rd_s=desktop-1&pf_rd_r=BS5M1H560SMAR2JDKYX3&pf_rd_r=BS5M1H560SMAR2JDKYX3&pf_rd_t=36701&pf_rd_p=6822bacc-d4f0-466d-83a8-2c5e1d703f8e&pf_rd_p=6822bacc-d4f0-466d-83a8-2c5e1d703f8e&pf_rd_i=desktop
File: 51301f3edb513f6543779c3a5433b01c

答案 4 :(得分:21)

这是您可以按照要求清理文件系统的方法

function filter_filename($name) {
    // remove illegal file system characters https://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words
    $name = str_replace(array_merge(
        array_map('chr', range(0, 31)),
        array('<', '>', ':', '"', '/', '\\', '|', '?', '*')
    ), '', $name);
    // maximise filename length to 255 bytes http://serverfault.com/a/9548/44086
    $ext = pathinfo($name, PATHINFO_EXTENSION);
    $name= mb_strcut(pathinfo($name, PATHINFO_FILENAME), 0, 255 - ($ext ? strlen($ext) + 1 : 0), mb_detect_encoding($name)) . ($ext ? '.' . $ext : '');
    return $name;
}

文件系统中允许其他所有内容,因此问题得到了完美答案......

...但如果您稍后在不安全的HTML上下文中使用它,那么可能在文件名中允许使用单引号'是危险的,因为这绝对合法的文件名:

 ' onerror= 'alert(document.cookie).jpg

成为XSS hole

<img src='<? echo $image ?>' />
// output:
<img src=' ' onerror= 'alert(document.cookie)' />

正因为如此,流行的CMS软件Wordpress将其删除,并且他们通过year通过艰难的方式(许多错误报告)了解year,这有助于添加越来越多的内容字符:

$special_chars = array("?", "[", "]", "/", "\\", "=", "<", ">", ":", ";", ",", "'", "\"", "&", "$", "#", "*", "(", ")", "|", "~", "`", "!", "{", "}", "%", "+", chr(0));
// ... a few rows later are whitespaces removed as well ...
preg_replace( '/[\r\n\t -]+/', '-', $filename )

最后,他们的列表现在包含了URI rerserved-charactersURL unsafe characters列表中的大部分字符。

当然你可以简单地在HTML输出上编码所有这些字符,但是大多数开发人员和我也遵循成语“更安全而不是抱歉”并提前删除它们。

所以最后我建议使用它:

function filter_filename($filename, $beautify=true) {
    // sanitize filename
    $filename = preg_replace(
        '~
        [<>:"/\\|?*]|            # file system reserved https://en.wikipedia.org/wiki/Filename#Reserved_characters_and_words
        [\x00-\x1F]|             # control characters http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247%28v=vs.85%29.aspx
        [\x7F\xA0\xAD]|          # non-printing characters DEL, NO-BREAK SPACE, SOFT HYPHEN
        [#\[\]@!$&\'()+,;=]|     # URI reserved https://tools.ietf.org/html/rfc3986#section-2.2
        [{}^\~`]                 # URL unsafe characters https://www.ietf.org/rfc/rfc1738.txt
        ~x',
        '-', $filename);
    // avoids ".", ".." or ".hiddenFiles"
    $filename = ltrim($filename, '.-');
    // optional beautification
    if ($beautify) $filename = beautify_filename($filename);
    // maximize filename length to 255 bytes http://serverfault.com/a/9548/44086
    $ext = pathinfo($filename, PATHINFO_EXTENSION);
    $filename = mb_strcut(pathinfo($filename, PATHINFO_FILENAME), 0, 255 - ($ext ? strlen($ext) + 1 : 0), mb_detect_encoding($filename)) . ($ext ? '.' . $ext : '');
    return $filename;
}

其他不会导致文件系统出现问题的其他内容应该是附加功能的一部分:

function beautify_filename($filename) {
    // reduce consecutive characters
    $filename = preg_replace(array(
        // "file   name.zip" becomes "file-name.zip"
        '/ +/',
        // "file___name.zip" becomes "file-name.zip"
        '/_+/',
        // "file---name.zip" becomes "file-name.zip"
        '/-+/'
    ), '-', $filename);
    $filename = preg_replace(array(
        // "file--.--.-.--name.zip" becomes "file.name.zip"
        '/-*\.-*/',
        // "file...name..zip" becomes "file.name.zip"
        '/\.{2,}/'
    ), '.', $filename);
    // lowercase for windows/unix interoperability http://support.microsoft.com/kb/100625
    $filename = mb_strtolower($filename, mb_detect_encoding($filename));
    // ".file-name.-" becomes "file-name"
    $filename = trim($filename, '.-');
    return $filename;
}

此时,如果结果为空,则需要生成文件名,并且可以决定是否要编码UTF-8字符。但是您不需要,因为在Web托管上下文中使用的所有文件系统都允许使用UTF-8。

您唯一需要做的就是使用urlencode()(因为您希望对所有网址都这样做),因此文件名საბეჭდი_მანქანა.jpg会成为您的<img src>或{{ 1}}: http://www.maxrev.de/html/img/%E1%83%A1%E1%83%90%E1%83%91%E1%83%94%E1%83%AD%E1%83%93%E1%83%98_%E1%83%9B%E1%83%90%E1%83%9C%E1%83%A5%E1%83%90%E1%83%9C%E1%83%90.jpg

Stackoverflow会这样做,所以我可以发布此链接,因为用户会这样做:
http://www.maxrev.de/html/img/საბეჭდი_მანქანა.jpg

因此,这是一个完整的法律文件名,不是问题,因为@SequenceDigitale.com mentioned in his answer

答案 5 :(得分:13)

preg_replace("[^\w\s\d\.\-_~,;:\[\]\(\]]", '', $file)

根据系统允许的内容添加/删除更多有效字符。

或者,您可以尝试创建该文件,如果错误则返回错误。

答案 6 :(得分:12)

好吧,tempnam()会为你做的。

http://us2.php.net/manual/en/function.tempnam.php

但这创造了一个全新的名称。

要清理现有字符串,只需限制用户可以输入的内容并将其设置为字母,数字,句点,连字符和下划线,然后使用简单的正则表达式进行清理。检查哪些字符需要转义,否则可能会出现误报。

$sanitized = preg_replace('/[^a-zA-Z0-9\-\._]/','', $filename);

答案 7 :(得分:7)

PHP提供了一种将文本清理为不同格式的功能

filter.filters.sanitize

如何:

echo filter_var(
   "Lorem Ipsum has been the industry's",FILTER_SANITIZE_URL
); 
  

Blockquote LoremIpsumhasbeentheindustry's

答案 8 :(得分:6)

对Sean Vieira的解决方案进行小幅调整以允许单点,您可以使用:

preg_replace("([^\w\s\d\.\-_~,;:\[\]\(\)]|[\.]{2,})", '', $file)

答案 9 :(得分:6)

以下表达式创建一个漂亮,干净且可用的字符串:

/[^a-z0-9\._-]+/gi

今天的财务:结算转变为今日财务结算

答案 10 :(得分:1)

这些可能有点沉重,但它们足够灵活,可以将任何字符串清理成“安全”en样式的文件名或文件夹名称(或者,如果你弯曲它,甚至是擦洗的slu and和东西)。

1)建立一个完整的文件名(如果输入被完全截断,则使用后备名称):

str_file($raw_string, $word_separator, $file_extension, $fallback_name, $length);

2)或者仅使用filter util而不构建完整的文件名(严格模式true将不允许文件名中的[]或()):

str_file_filter($string, $separator, $strict, $length);

3)以下是这些功能:

// Returns filesystem-safe string after cleaning, filtering, and trimming input
function str_file_filter(
    $str,
    $sep = '_',
    $strict = false,
    $trim = 248) {

    $str = strip_tags(htmlspecialchars_decode(strtolower($str))); // lowercase -> decode -> strip tags
    $str = str_replace("%20", ' ', $str); // convert rogue %20s into spaces
    $str = preg_replace("/%[a-z0-9]{1,2}/i", '', $str); // remove hexy things
    $str = str_replace("&nbsp;", ' ', $str); // convert all nbsp into space
    $str = preg_replace("/&#?[a-z0-9]{2,8};/i", '', $str); // remove the other non-tag things
    $str = preg_replace("/\s+/", $sep, $str); // filter multiple spaces
    $str = preg_replace("/\.+/", '.', $str); // filter multiple periods
    $str = preg_replace("/^\.+/", '', $str); // trim leading period

    if ($strict) {
        $str = preg_replace("/([^\w\d\\" . $sep . ".])/", '', $str); // only allow words and digits
    } else {
        $str = preg_replace("/([^\w\d\\" . $sep . "\[\]\(\).])/", '', $str); // allow words, digits, [], and ()
    }

    $str = preg_replace("/\\" . $sep . "+/", $sep, $str); // filter multiple separators
    $str = substr($str, 0, $trim); // trim filename to desired length, note 255 char limit on windows

    return $str;
}


// Returns full file name including fallback and extension
function str_file(
    $str,
    $sep = '_',
    $ext = '',
    $default = '',
    $trim = 248) {

    // Run $str and/or $ext through filters to clean up strings
    $str = str_file_filter($str, $sep);
    $ext = '.' . str_file_filter($ext, '', true);

    // Default file name in case all chars are trimmed from $str, then ensure there is an id at tail
    if (empty($str) && empty($default)) {
        $str = 'no_name__' . date('Y-m-d_H-m_A') . '__' . uniqid();
    } elseif (empty($str)) {
        $str = $default;
    }

    // Return completed string
    if (!empty($ext)) {
        return $str . $ext;
    } else {
        return $str;
    }
}

因此,假设某些用户输入为:.....&lt;div&gt;&lt;/div&gt;<script></script>&amp; Weiß Göbel 中文百强网File name %20 %20 %21 %2C Décor \/. /. . z \... y \...... x ./ “This name” is & 462^^ not &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = that grrrreat -][09]()1234747) საბეჭდი-და-ტიპოგრაფიული

我们希望将其转换为更友好的东西,以制作文件名长度为255个字符的tar.gz。这是一个示例用法。注意:此示例包含格式错误的tar.gz扩展名作为概念证明,您仍应在针对白名单构建字符串后过滤ext。

$raw_str = '.....&lt;div&gt;&lt;/div&gt;<script></script>&amp; Weiß Göbel 中文百强网File name  %20   %20 %21 %2C Décor  \/.  /. .  z \... y \...... x ./  “This name” is & 462^^ not &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; = that grrrreat -][09]()1234747) საბეჭდი-და-ტიპოგრაფიული';
$fallback_str = 'generated_' . date('Y-m-d_H-m_A');
$bad_extension = '....t&+++a()r.gz[]';

echo str_file($raw_str, '_', $bad_extension, $fallback_str);

输出结果为:_wei_gbel_file_name_dcor_._._._z_._y_._x_._this_name_is_462_not_that_grrrreat_][09]()1234747)_.tar.gz

您可以在此处播放:https://3v4l.org/iSgi8

或要点:https://gist.github.com/dhaupin/b109d3a8464239b7754a

编辑更新了&nbsp;的脚本过滤器而非空格,更新了3v4l链接

答案 11 :(得分:1)

我今天所知道的最好的是来自Nette框架的静态方法Strings::webalize

顺便说一句,这会将所有变音符号转换为基本符号.š=&gt;sü=&gt;uß=&gt; ss等。

对于文件名,您必须添加点“。”允许字符参数。

/**
 * Converts to ASCII.
 * @param  string  UTF-8 encoding
 * @return string  ASCII
 */
public static function toAscii($s)
{
    static $transliterator = NULL;
    if ($transliterator === NULL && class_exists('Transliterator', FALSE)) {
        $transliterator = \Transliterator::create('Any-Latin; Latin-ASCII');
    }

    $s = preg_replace('#[^\x09\x0A\x0D\x20-\x7E\xA0-\x{2FF}\x{370}-\x{10FFFF}]#u', '', $s);
    $s = strtr($s, '`\'"^~?', "\x01\x02\x03\x04\x05\x06");
    $s = str_replace(
        array("\xE2\x80\x9E", "\xE2\x80\x9C", "\xE2\x80\x9D", "\xE2\x80\x9A", "\xE2\x80\x98", "\xE2\x80\x99", "\xC2\xB0"),
        array("\x03", "\x03", "\x03", "\x02", "\x02", "\x02", "\x04"), $s
    );
    if ($transliterator !== NULL) {
        $s = $transliterator->transliterate($s);
    }
    if (ICONV_IMPL === 'glibc') {
        $s = str_replace(
            array("\xC2\xBB", "\xC2\xAB", "\xE2\x80\xA6", "\xE2\x84\xA2", "\xC2\xA9", "\xC2\xAE"),
            array('>>', '<<', '...', 'TM', '(c)', '(R)'), $s
        );
        $s = @iconv('UTF-8', 'WINDOWS-1250//TRANSLIT//IGNORE', $s); // intentionally @
        $s = strtr($s, "\xa5\xa3\xbc\x8c\xa7\x8a\xaa\x8d\x8f\x8e\xaf\xb9\xb3\xbe\x9c\x9a\xba\x9d\x9f\x9e"
            . "\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0\xd1\xd2\xd3"
            . "\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf\xe0\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8"
            . "\xe9\xea\xeb\xec\xed\xee\xef\xf0\xf1\xf2\xf3\xf4\xf5\xf6\xf8\xf9\xfa\xfb\xfc\xfd\xfe"
            . "\x96\xa0\x8b\x97\x9b\xa6\xad\xb7",
            'ALLSSSSTZZZallssstzzzRAAAALCCCEEEEIIDDNNOOOOxRUUUUYTsraaaalccceeeeiiddnnooooruuuuyt- <->|-.');
        $s = preg_replace('#[^\x00-\x7F]++#', '', $s);
    } else {
        $s = @iconv('UTF-8', 'ASCII//TRANSLIT//IGNORE', $s); // intentionally @
    }
    $s = str_replace(array('`', "'", '"', '^', '~', '?'), '', $s);
    return strtr($s, "\x01\x02\x03\x04\x05\x06", '`\'"^~?');
}


/**
 * Converts to web safe characters [a-z0-9-] text.
 * @param  string  UTF-8 encoding
 * @param  string  allowed characters
 * @param  bool
 * @return string
 */
public static function webalize($s, $charlist = NULL, $lower = TRUE)
{
    $s = self::toAscii($s);
    if ($lower) {
        $s = strtolower($s);
    }
    $s = preg_replace('#[^a-z0-9' . preg_quote($charlist, '#') . ']+#i', '-', $s);
    $s = trim($s, '-');
    return $s;
}

答案 12 :(得分:1)

似乎这一切都取决于问题,是否有可能创建一个可用于入侵服务器的文件名(或做一些其他损害)。如果没有,那么似乎简单的答案是尝试创建文件,最终将被使用(因为这将是首选的操作系统,毫无疑问)。让操作系统对其进行排序。如果它抱怨,请将该投诉作为验证错误返回给用户。

这具有可靠移植的额外好处,因为如果没有为该操作系统正确形成文件名,所有(我很确定)操作系统都会抱怨。

如果 可以使用文件名进行邪恶的事情,也许在测试驻留操作系统上的文件名之前可以应用一些措施 - 措施不如完整的&#34复杂;卫生&#34;文件名。

答案 13 :(得分:0)

单程

$bad='/[\/:*?"<>|]/';
$string = 'fi?le*';

function sanitize($str,$pat)
{
    return preg_replace($pat,"",$str);

}
echo sanitize($string,$bad);

答案 14 :(得分:0)

用户提供的文件名中的

/..可能有害。所以你应该通过以下方式摆脱这些:

$fname = str_replace('..', '', $fname);
$fname = str_replace('/',  '', $fname);

答案 15 :(得分:0)

安全:将非“ a-zA-Z0-9_-”的每个序列替换为破折号; 自己添加扩展程序。

$name = preg_replace('/[^a-zA-Z0-9_-]+/', '-', strtolower($name)).$extension;

答案 16 :(得分:-4)

  

$ fname = str_replace('/','',$ fname);

由于用户可能会使用斜杠来分隔两个单词,因此最好用短划线代替NULL