Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 :
21 : #include "unotools/configpaths.hxx"
22 : #include <rtl/ustring.hxx>
23 : #include <rtl/ustrbuf.hxx>
24 : #include <osl/diagnose.h>
25 :
26 : //----------------------------------------------------------------------------
27 : namespace utl
28 : {
29 : //----------------------------------------------------------------------------
30 :
31 : using ::rtl::OUString;
32 : using ::rtl::OUStringBuffer;
33 :
34 : //----------------------------------------------------------------------------
35 :
36 : static
37 2002 : void lcl_resolveCharEntities(OUString & aLocalString)
38 : {
39 2002 : sal_Int32 nEscapePos=aLocalString.indexOf('&');
40 4004 : if (nEscapePos < 0) return;
41 :
42 0 : OUStringBuffer aResult;
43 0 : sal_Int32 nStart = 0;
44 :
45 0 : do
46 : {
47 0 : sal_Unicode ch = 0;
48 0 : if (aLocalString.matchAsciiL(RTL_CONSTASCII_STRINGPARAM("&"),nEscapePos))
49 0 : ch = '&';
50 :
51 0 : else if (aLocalString.matchAsciiL(RTL_CONSTASCII_STRINGPARAM("'"),nEscapePos))
52 0 : ch = '\'';
53 :
54 0 : else if (aLocalString.matchAsciiL(RTL_CONSTASCII_STRINGPARAM("""),nEscapePos))
55 0 : ch = '"';
56 :
57 : OSL_ENSURE(ch,"Configuration path contains '&' that is not part of a valid character escape");
58 0 : if (ch)
59 : {
60 0 : aResult.append(aLocalString.copy(nStart,nEscapePos-nStart)).append(ch);
61 :
62 0 : sal_Int32 nEscapeEnd=aLocalString.indexOf(';',nEscapePos);
63 0 : nStart = nEscapeEnd+1;
64 0 : nEscapePos=aLocalString.indexOf('&',nStart);
65 : }
66 : else
67 : {
68 0 : nEscapePos=aLocalString.indexOf('&',nEscapePos+1);
69 : }
70 : }
71 : while ( nEscapePos > 0);
72 :
73 0 : aResult.append(aLocalString.copy(nStart));
74 :
75 0 : aLocalString = aResult.makeStringAndClear();
76 : }
77 :
78 : //----------------------------------------------------------------------------
79 1836 : sal_Bool splitLastFromConfigurationPath(OUString const& _sInPath,
80 : OUString& _rsOutPath,
81 : OUString& _rsLocalName)
82 : {
83 : sal_Int32 nStart,nEnd;
84 :
85 1836 : sal_Int32 nPos = _sInPath.getLength()-1;
86 :
87 : // strip trailing slash
88 1836 : if (nPos > 0 && _sInPath[ nPos ] == sal_Unicode('/'))
89 : {
90 : OSL_FAIL("Invalid config path: trailing '/' is not allowed");
91 0 : --nPos;
92 : }
93 :
94 : // check for predicate ['xxx'] or ["yyy"]
95 1836 : if (nPos > 0 && _sInPath[ nPos ] == sal_Unicode(']'))
96 : {
97 0 : sal_Unicode chQuote = _sInPath[--nPos];
98 :
99 0 : if (chQuote == '\'' || chQuote == '\"')
100 : {
101 0 : nEnd = nPos;
102 0 : nPos = _sInPath.lastIndexOf(chQuote,nEnd);
103 0 : nStart = nPos + 1;
104 0 : --nPos; // nPos = rInPath.lastIndexOf('[',nPos);
105 : }
106 : else // allow [xxx]
107 : {
108 0 : nEnd = nPos + 1;
109 0 : nPos = _sInPath.lastIndexOf('[',nEnd);
110 0 : nStart = nPos + 1;
111 : }
112 :
113 : OSL_ENSURE(nPos >= 0 && _sInPath[nPos] == '[', "Invalid config path: unmatched quotes or brackets");
114 0 : if (nPos >= 0 && _sInPath[nPos] == '[')
115 : {
116 0 : nPos = _sInPath.lastIndexOf('/',nPos);
117 : }
118 : else // defined behavior for invalid paths
119 : {
120 0 : nStart = 0, nEnd = _sInPath.getLength();
121 0 : nPos = -1;
122 : }
123 :
124 : }
125 : else
126 : {
127 1836 : nEnd = nPos+1;
128 1836 : nPos = _sInPath.lastIndexOf('/',nEnd);
129 1836 : nStart = nPos + 1;
130 : }
131 : OSL_ASSERT( -1 <= nPos &&
132 : nPos < nStart &&
133 : nStart < nEnd &&
134 : nEnd <= _sInPath.getLength() );
135 :
136 : OSL_ASSERT(nPos == -1 || _sInPath[nPos] == '/');
137 : OSL_ENSURE(nPos != 0 , "Invalid config child path: immediate child of root");
138 :
139 1836 : _rsLocalName = _sInPath.copy(nStart, nEnd-nStart);
140 1836 : _rsOutPath = (nPos > 0) ? _sInPath.copy(0,nPos) : OUString();
141 1836 : lcl_resolveCharEntities(_rsLocalName);
142 :
143 1836 : return nPos >= 0;
144 : }
145 :
146 : //----------------------------------------------------------------------------
147 166 : OUString extractFirstFromConfigurationPath(OUString const& _sInPath, OUString* _sOutPath)
148 : {
149 166 : sal_Int32 nSep = _sInPath.indexOf('/');
150 166 : sal_Int32 nBracket = _sInPath.indexOf('[');
151 :
152 166 : sal_Int32 nStart = nBracket + 1;
153 166 : sal_Int32 nEnd = nSep;
154 :
155 166 : if (0 <= nBracket) // found a bracket-quoted relative path
156 : {
157 166 : if (nSep < 0 || nBracket < nSep) // and the separator comes after it
158 : {
159 166 : sal_Unicode chQuote = _sInPath[nStart];
160 166 : if (chQuote == '\'' || chQuote == '\"')
161 : {
162 166 : ++nStart;
163 166 : nEnd = _sInPath.indexOf(chQuote, nStart+1);
164 166 : nBracket = nEnd+1;
165 : }
166 : else
167 : {
168 0 : nEnd = _sInPath.indexOf(']',nStart);
169 0 : nBracket = nEnd;
170 : }
171 : OSL_ENSURE(nEnd > nStart && _sInPath[nBracket] == ']', "Invalid config path: improper mismatch of quote or bracket");
172 166 : OSL_ENSURE((nBracket+1 == _sInPath.getLength() && nSep == -1) || (_sInPath[nBracket+1] == '/' && nSep == nBracket+1), "Invalid config path: brackets not followed by slash");
173 : }
174 : else // ... but our initial element name is in simple form
175 0 : nStart = 0;
176 : }
177 :
178 166 : OUString sResult = (nEnd >= 0) ? _sInPath.copy(nStart, nEnd-nStart) : _sInPath;
179 166 : lcl_resolveCharEntities(sResult);
180 :
181 166 : if (_sOutPath != 0)
182 : {
183 0 : *_sOutPath = (nSep >= 0) ? _sInPath.copy(nSep + 1) : OUString();
184 : }
185 :
186 166 : return sResult;
187 : }
188 :
189 : //----------------------------------------------------------------------------
190 :
191 : // find the position after the prefix in the nested path
192 : static inline
193 1557 : sal_Int32 lcl_findPrefixEnd(OUString const& _sNestedPath, OUString const& _sPrefixPath)
194 : {
195 : // TODO: currently handles only exact prefix matches
196 1557 : sal_Int32 nPrefixLength = _sPrefixPath.getLength();
197 :
198 : OSL_ENSURE(nPrefixLength == 0 || _sPrefixPath[nPrefixLength-1] != '/',
199 : "Cannot handle slash-terminated prefix paths");
200 :
201 : sal_Bool bIsPrefix;
202 1557 : if (_sNestedPath.getLength() > nPrefixLength)
203 : {
204 1482 : bIsPrefix = _sNestedPath[nPrefixLength] == '/' &&
205 1482 : _sNestedPath.compareTo(_sPrefixPath,nPrefixLength) == 0;
206 1482 : ++nPrefixLength;
207 : }
208 75 : else if (_sNestedPath.getLength() == nPrefixLength)
209 : {
210 37 : bIsPrefix = _sNestedPath.equals(_sPrefixPath);
211 : }
212 : else
213 : {
214 38 : bIsPrefix = false;
215 : }
216 :
217 1557 : return bIsPrefix ? nPrefixLength : 0;
218 : }
219 :
220 : //----------------------------------------------------------------------------
221 1557 : sal_Bool isPrefixOfConfigurationPath(OUString const& _sNestedPath,
222 : OUString const& _sPrefixPath)
223 : {
224 1557 : return _sPrefixPath.isEmpty() || lcl_findPrefixEnd(_sNestedPath,_sPrefixPath) != 0;
225 : }
226 :
227 : //----------------------------------------------------------------------------
228 0 : OUString dropPrefixFromConfigurationPath(OUString const& _sNestedPath,
229 : OUString const& _sPrefixPath)
230 : {
231 0 : if ( sal_Int32 nPrefixEnd = lcl_findPrefixEnd(_sNestedPath,_sPrefixPath) )
232 : {
233 0 : return _sNestedPath.copy(nPrefixEnd);
234 : }
235 : else
236 : {
237 : OSL_ENSURE(_sPrefixPath.isEmpty(), "Path does not start with expected prefix");
238 :
239 0 : return _sNestedPath;
240 : }
241 : }
242 :
243 : //----------------------------------------------------------------------------
244 : static
245 306 : OUString lcl_wrapName(const OUString& _sContent, const OUString& _sType)
246 : {
247 306 : const sal_Unicode * const pBeginContent = _sContent.getStr();
248 306 : const sal_Unicode * const pEndContent = pBeginContent + _sContent.getLength();
249 :
250 : OSL_PRECOND(!_sType.isEmpty(), "Unexpected config type name: empty");
251 : OSL_PRECOND(pBeginContent <= pEndContent, "Invalid config name: empty");
252 :
253 306 : if (pBeginContent == pEndContent)
254 0 : return _sType;
255 :
256 306 : rtl::OUStringBuffer aNormalized(_sType.getLength() + _sContent.getLength() + 4); // reserve approximate size initially
257 :
258 : // prefix: type, opening bracket and quote
259 306 : aNormalized.append( _sType ).appendAscii( RTL_CONSTASCII_STRINGPARAM("['") );
260 :
261 : // content: copy over each char and handle escaping
262 11624 : for(const sal_Unicode* pCur = pBeginContent; pCur != pEndContent; ++pCur)
263 : {
264 : // append (escape if needed)
265 11318 : switch(*pCur)
266 : {
267 0 : case sal_Unicode('&') : aNormalized.appendAscii( RTL_CONSTASCII_STRINGPARAM("&") ); break;
268 0 : case sal_Unicode('\''): aNormalized.appendAscii( RTL_CONSTASCII_STRINGPARAM("'") ); break;
269 0 : case sal_Unicode('\"'): aNormalized.appendAscii( RTL_CONSTASCII_STRINGPARAM(""") ); break;
270 :
271 11318 : default: aNormalized.append( *pCur );
272 : }
273 : }
274 :
275 : // suffix: closing quote and bracket
276 306 : aNormalized.appendAscii( RTL_CONSTASCII_STRINGPARAM("']") );
277 :
278 306 : return aNormalized.makeStringAndClear();
279 : }
280 :
281 : //----------------------------------------------------------------------------
282 :
283 306 : OUString wrapConfigurationElementName(OUString const& _sElementName)
284 : {
285 306 : return lcl_wrapName(_sElementName, OUString(RTL_CONSTASCII_USTRINGPARAM("*")) );
286 : }
287 :
288 : //----------------------------------------------------------------------------
289 :
290 0 : OUString wrapConfigurationElementName(OUString const& _sElementName,
291 : OUString const& _sTypeName)
292 : {
293 : // todo: check that _sTypeName is valid
294 0 : return lcl_wrapName(_sElementName, _sTypeName);
295 : }
296 :
297 : //----------------------------------------------------------------------------
298 : } // namespace utl
299 :
300 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
