mpd/src/tag/FixString.cxx

145 lines
3.4 KiB
C++

/*
* Copyright 2003-2021 The Music Player Daemon Project
* http://www.musicpd.org
*
* This program 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 2 of the License, or
* (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include "FixString.hxx"
#include "util/AllocatedArray.hxx"
#include "util/CharUtil.hxx"
#include "util/UTF8.hxx"
#include <algorithm>
#include <cassert>
#include <stdlib.h>
[[gnu::pure]]
static const char *
FindInvalidUTF8(const char *p, const char *const end) noexcept
{
while (p < end) {
const size_t s = SequenceLengthUTF8(*p);
if (p + s > end)
/* partial sequence at end of string */
return p;
/* now call the other SequenceLengthUTF8() overload
which also validates the continuations */
const size_t t = SequenceLengthUTF8(p);
if (t == 0)
return p;
assert(s == t);
p += s;
}
return nullptr;
}
/**
* Replace invalid sequences with the question mark.
*/
static AllocatedArray<char>
patch_utf8(std::string_view src, const char *_invalid) noexcept
{
/* duplicate the string, and replace invalid bytes in that
buffer */
AllocatedArray<char> dest{src};
char *const end = dest.data() + src.size();
char *invalid = dest.data() + (_invalid - src.data());
do {
*invalid = '?';
const char *__invalid = FindInvalidUTF8(invalid + 1, end);
invalid = const_cast<char *>(__invalid);
} while (invalid != nullptr);
return dest;
}
static AllocatedArray<char>
fix_utf8(std::string_view p) noexcept
{
/* check if the string is already valid UTF-8 */
const char *invalid = FindInvalidUTF8(p.data(), p.data() + p.size());
if (invalid == nullptr)
return nullptr;
/* no, broken - patch invalid sequences */
return patch_utf8(p, invalid);
}
[[gnu::pure]]
static const char *
find_non_printable(std::string_view p) noexcept
{
for (const char &ch : p)
if (IsNonPrintableASCII(ch))
return &ch;
return nullptr;
}
/**
* Clears all non-printable characters, convert them to space.
* Returns nullptr if nothing needs to be cleared.
*/
static AllocatedArray<char>
clear_non_printable(std::string_view src)
{
const char *first = find_non_printable(src);
if (first == nullptr)
return nullptr;
AllocatedArray<char> dest{src};
for (size_t i = first - src.data(); i < src.size(); ++i)
if (IsNonPrintableASCII(dest[i]))
dest[i] = ' ';
return dest;
}
[[gnu::pure]]
static bool
IsSafe(std::string_view s) noexcept
{
return std::all_of(s.begin(), s.end(),
[](char ch){
return IsASCII(ch) && IsPrintableASCII(ch);
});
}
AllocatedArray<char>
FixTagString(std::string_view p) noexcept
{
if (IsSafe(p))
/* optimistic optimization for the common case */
return nullptr;
auto utf8 = fix_utf8(p);
if (utf8 != nullptr)
p = {utf8.data(), utf8.size()};
auto cleared = clear_non_printable(p);
if (cleared == nullptr)
cleared = std::move(utf8);
return cleared;
}