/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <sal/config.h>
#include <cassert>
#include <string_view>
#include <unotools/configpaths.hxx>
#include <rtl/ustring.hxx>
#include <rtl/ustrbuf.hxx>
#include <osl/diagnose.h>
#include <o3tl/string_view.hxx>
namespace utl
{
static
void lcl_resolveCharEntities(OUString & aLocalString)
{
sal_Int32 nEscapePos=aLocalString.indexOf('&');
if (nEscapePos < 0) return;
OUStringBuffer aResult;
sal_Int32 nStart = 0;
do
{
sal_Unicode ch = 0;
if (aLocalString.match("&",nEscapePos))
ch = '&';
else if (aLocalString.match("'",nEscapePos))
ch = '\'';
else if (aLocalString.match(""",nEscapePos))
ch = '"';
OSL_ENSURE(ch,"Configuration path contains '&' that is not part of a valid character escape");
if (ch)
{
aResult.append(aLocalString.subView(nStart,nEscapePos-nStart) + OUStringChar(ch));
sal_Int32 nEscapeEnd=aLocalString.indexOf(';',nEscapePos);
nStart = nEscapeEnd+1;
nEscapePos=aLocalString.indexOf('&',nStart);
}
else
{
nEscapePos=aLocalString.indexOf('&',nEscapePos+1);
}
}
while ( nEscapePos > 0);
aResult.append(aLocalString.subView(nStart));
aLocalString = aResult.makeStringAndClear();
}
bool splitLastFromConfigurationPath(std::u16string_view _sInPath,
OUString& _rsOutPath,
OUString& _rsLocalName)
{
size_t nStart,nEnd;
size_t nPos = _sInPath.size();
// for backwards compatibility, strip trailing slash
if (nPos > 1 && _sInPath[ nPos - 1 ] == '/')
{
--nPos;
}
// check for set element ['xxx'] or ["yyy"]
bool decode;
if (nPos > 0 && _sInPath[ nPos - 1 ] == ']')
{
decode = true;
if (nPos < 3) { // expect at least chQuote + chQuote + ']' at _sInPath[nPos-3..nPos-1]
goto invalid;
}
nPos -= 2;
sal_Unicode chQuote = _sInPath[nPos];
if (chQuote == '\'' || chQuote == '\"')
{
nEnd = nPos;
nPos = _sInPath.rfind(chQuote,nEnd - 1);
if (nPos == std::u16string_view::npos) {
goto invalid;
}
nStart = nPos + 1;
}
else
{
goto invalid;
}
OSL_ENSURE(nPos > 0 && _sInPath[nPos - 1] == '[', "Invalid config path: unmatched quotes or brackets");
if (nPos > 1 && _sInPath[nPos - 1] == '[')
// expect at least '/' + '[' at _sInPath[nPos-2..nPos-1]
{
nPos = _sInPath.rfind('/',nPos - 2);
if (nPos == std::u16string_view::npos) {
goto invalid;
}
}
else
{
goto invalid;
}
}
else
{
decode = false;
nEnd = nPos;
if (nEnd == 0) {
goto invalid;
}
nPos = _sInPath.rfind('/',nEnd - 1);
if (nPos == std::u16string_view::npos) {
goto invalid;
}
nStart = nPos + 1;
}
assert( nPos != std::u16string_view::npos &&
nPos < nStart &&
nStart <= nEnd &&
nEnd <= _sInPath.size() );
assert(_sInPath[nPos] == '/');
OSL_ENSURE(nPos != 0 , "Invalid config child path: immediate child of root");
_rsLocalName = _sInPath.substr(nStart, nEnd-nStart);
_rsOutPath = (nPos > 0) ? OUString(_sInPath.substr(0,nPos)) : OUString();
if (decode) {
lcl_resolveCharEntities(_rsLocalName);
}
return true;
invalid:
_rsOutPath.clear();
_rsLocalName = _sInPath;
return false;
}
OUString extractFirstFromConfigurationPath(OUString const& _sInPath, OUString* _sOutPath)
{
sal_Int32 nSep = _sInPath.indexOf('/');
sal_Int32 nBracket = _sInPath.indexOf('[');
sal_Int32 nStart = nBracket + 1;
sal_Int32 nEnd = nSep;
if (0 <= nBracket) // found a bracket-quoted relative path
{
if (nSep < 0 || nBracket < nSep) // and the separator comes after it
{
sal_Unicode chQuote = _sInPath[nStart];
if (chQuote == '\'' || chQuote == '\"')
{
++nStart;
nEnd = _sInPath.indexOf(chQuote, nStart+1);
nBracket = nEnd+1;
}
else
{
nEnd = _sInPath.indexOf(']',nStart);
nBracket = nEnd;
}
OSL_ENSURE(nEnd > nStart && _sInPath[nBracket] == ']', "Invalid config path: improper mismatch of quote or bracket");
OSL_ENSURE((nBracket+1 == _sInPath.getLength() && nSep == -1) || (_sInPath[nBracket+1] == '/' && nSep == nBracket+1), "Invalid config path: brackets not followed by slash");
}
else // ... but our initial element name is in simple form
nStart = 0;
}
OUString sResult = (nEnd >= 0) ? _sInPath.copy(nStart, nEnd-nStart) : _sInPath;
lcl_resolveCharEntities(sResult);
if (_sOutPath != nullptr)
{
*_sOutPath = (nSep >= 0) ? _sInPath.copy(nSep + 1) : OUString();
}
return sResult;
}
// find the position after the prefix in the nested path
static sal_Int32 lcl_findPrefixEnd(std::u16string_view _sNestedPath, std::u16string_view _sPrefixPath)
{
// TODO: currently handles only exact prefix matches
size_t nPrefixLength = _sPrefixPath.size();
OSL_ENSURE(nPrefixLength == 0 || _sPrefixPath[nPrefixLength-1] != '/',
"Cannot handle slash-terminated prefix paths");
bool bIsPrefix;
if (_sNestedPath.size() > nPrefixLength)
{
bIsPrefix = _sNestedPath[nPrefixLength] == '/' &&
o3tl::starts_with(_sNestedPath, _sPrefixPath);
++nPrefixLength;
}
else if (_sNestedPath.size() == nPrefixLength)
{
bIsPrefix = _sNestedPath == _sPrefixPath;
}
else
{
bIsPrefix = false;
}
return bIsPrefix ? nPrefixLength : 0;
}
bool isPrefixOfConfigurationPath(std::u16string_view _sNestedPath,
std::u16string_view _sPrefixPath)
{
return _sPrefixPath.empty() || lcl_findPrefixEnd(_sNestedPath,_sPrefixPath) != 0;
}
OUString dropPrefixFromConfigurationPath(OUString const& _sNestedPath,
std::u16string_view _sPrefixPath)
{
if ( sal_Int32 nPrefixEnd = lcl_findPrefixEnd(_sNestedPath,_sPrefixPath) )
{
return _sNestedPath.copy(nPrefixEnd);
}
else
{
OSL_ENSURE(_sPrefixPath.empty(), "Path does not start with expected prefix");
return _sNestedPath;
}
}
static
OUString lcl_wrapName(std::u16string_view _sContent, const OUString& _sType)
{
const sal_Unicode * const pBeginContent = _sContent.data();
const sal_Unicode * const pEndContent = pBeginContent + _sContent.size();
OSL_PRECOND(!_sType.isEmpty(), "Unexpected config type name: empty");
OSL_PRECOND(pBeginContent <= pEndContent, "Invalid config name: empty");
if (pBeginContent == pEndContent)
return _sType;
OUStringBuffer aNormalized(_sType.getLength() + _sContent.size() + 4); // reserve approximate size initially
// prefix: type, opening bracket and quote
aNormalized.append( _sType + "['" );
// content: copy over each char and handle escaping
for(const sal_Unicode* pCur = pBeginContent; pCur != pEndContent; ++pCur)
{
// append (escape if needed)
switch(*pCur)
{
case u'&' : aNormalized.append( "&" ); break;
case u'\'': aNormalized.append( "'" ); break;
case u'\"': aNormalized.append( """ ); break;
default: aNormalized.append( *pCur );
}
}
// suffix: closing quote and bracket
aNormalized.append( "']" );
return aNormalized.makeStringAndClear();
}
OUString wrapConfigurationElementName(std::u16string_view _sElementName)
{
return lcl_wrapName(_sElementName, u"*"_ustr );
}
OUString wrapConfigurationElementName(std::u16string_view _sElementName,
OUString const& _sTypeName)
{
// todo: check that _sTypeName is valid
return lcl_wrapName(_sElementName, _sTypeName);
}
} // namespace utl
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
↑ V530 The return value of function 'append' is required to be utilized.
↑ V530 The return value of function 'append' is required to be utilized.
↑ V530 The return value of function 'append' is required to be utilized.