src/common/Path.cpp

/***************************************************************************
 *                                                                         *
 *   Copyright (C) 2007 Christian Schoenebeck                              *
 *                                                                         *
 *   This library 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 library 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 library; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#include "Path.h"

// for function hexsToNumber()
#include "global_private.h"

#include <sstream>

namespace LinuxSampler {

Path::Path() : drive(0) {
}

void Path::appendNode(std::string Name) {
    if (!Name.size()) return;
    elements.push_back(Name);
}

void Path::setDrive(const char& Drive) {
    drive = Drive;
}

std::string Path::toPosix() const {
    // POSIX paths consist of forward slash separators and requires forward
    // slashes in path and file names to be encoded as "%2f", the file names
    // "." and ".." have special meanings
    // (see http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap03.html#tag_03_169
    // and http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap03.html#tag_03_266 )
    std::string result;
    for (int iElement = 0; iElement < elements.size(); iElement++) {
        // encode percent characters
        std::string e = elements[iElement];
        for (
            int pos = e.find("%"); pos != std::string::npos;
            pos = e.find("%", pos+2)
        ) e.replace(pos/*offset*/, 1/*length*/, "%%"/*by*/);
        // encode forward slashes
        for (
            int pos = e.find("/"); pos != std::string::npos;
            pos = e.find("/", pos+3)
        ) e.replace(pos/*offset*/, 1/*length*/, "%2f"/*by*/);
        // append encoded node to full encoded path
        result += "/" + e;
    }
    if (!result.size()) result = "/";
    return result;
}

std::string Path::toDbPath() const {
    std::string result;
    for (int iElement = 0; iElement < elements.size(); iElement++) {
        // replace all slashes with '\0'
        std::string e = elements[iElement];
        for (int i = 0; i < e.length(); i++) {
            if (e.at(i) == '/') e.at(i) = '\0';
        }
        // append encoded node to full encoded path
        result += "/" + e;
    }
    if (!result.size()) result = "/";
    return result;
}

std::string Path::toLscp() const {
    std::string result;
    for (int iElement = 0; iElement < elements.size(); iElement++) {
        // replace "special characters" by LSCP escape sequences
        std::string e = elements[iElement];
        for (int i = 0; i < e.length(); i++) {
            const char c = e.c_str()[i];
            if (
                !(c >= '0' && c <= '9') &&
                !(c >= 'a' && c <= 'z') &&
                !(c >= 'A' && c <= 'Z') &&
                !(c == '!') && !(c == '#') && !(c == '$') && !(c == '%') &&
                !(c == '&') && !(c == '(') && !(c == ')') && !(c == '*') &&
                !(c == '+') && !(c == ',') && !(c == '-') && !(c == '.') &&
                !(c == ':') && !(c == ';') && !(c == '<') && !(c == '=') &&
                !(c == '>') && !(c == '?') && !(c == '@') && !(c == '[') &&
                !(c == ']') && !(c == '^') && !(c == '_') && !(c == '`') &&
                !(c == '{') && !(c == '|') && !(c == '}') && !(c == '~')
            ) {
                // convert the "special" character into a "\xHH" LSCP escape sequence
                char buf[5];
                snprintf(buf, sizeof(buf), "\\x%02x", static_cast<unsigned char>(c));
                e.replace(i, 1, buf);
                i += 3;
            }
        }
        // append encoded node to full encoded path
        result += "/" + e;
    }
    if (!result.size()) result = "/";
    return result;
}

std::string Path::toWindows() const {
    std::stringstream result;
    result <<
        ((drive >= 'A' && drive <= 'Z') || (drive >= 'a' && drive <= 'z'))
            ? drive : '?';
    result << ':';
    for (int iElement = 0; iElement < elements.size(); iElement++) {
        // append encoded node to full encoded path
        result << "\\" << elements[iElement];
    }
    return result.str();
}

Path Path::operator+(const Path& p) {
    Path result = *this;
    for (int i = 0; i < p.elements.size(); i++)
        result.elements.push_back(p.elements[i]);
    return result;
}

Path Path::operator+(const Path* p) {
    return *this + *p;
}

Path Path::fromPosix(std::string path) {
    Path result;
    // first split the nodes
    {
        int nodeEnd;
        for (
            int nodeBegin = path.find_first_not_of('/');
            nodeBegin != std::string::npos;
            nodeBegin = path.find_first_not_of('/', nodeEnd)
        ) {
            nodeEnd = path.find_first_of('/', nodeBegin);
            result.appendNode(
                (nodeEnd != std::string::npos) ?
                    path.substr(nodeBegin, nodeEnd - nodeBegin) :
                    path.substr(nodeBegin)
            );
        }
    }
    // resolve POSIX escape sequences in all nodes
    for (int iNode = 0; iNode < result.elements.size(); iNode++) {
        std::string& s = result.elements[iNode];
        for (int pos = s.find('%'); pos < s.length(); pos = s.find('%', ++pos)) {
            if (pos+1 >= s.length()) { // unexpected character
                //TODO: we might want to throw an exception here, for now we simply replace the character by '?'
                s.replace(pos, 1, "?");
                continue;
            }
            if (s.c_str()[pos+1] == '%') {
                s.replace(pos, 2, "%");
                continue;
            }
            if (pos+2 >= s.length()) {
                //TODO: we might want to throw an exception here, for now we simply replace the character by '?'
                s.replace(pos, 2, "?");
                continue;
            }
            // expecting a "%HH" sequence here, convert it into the respective character
            const std::string sHex = s.substr(pos+1, 2);
            char cAscii = hexsToNumber(sHex.c_str()[1], sHex.c_str()[0]);
            char pcAscii[] = { cAscii, 0 };
            s.replace(pos, 3, pcAscii);
        }
    }
    return result;
}

Path Path::fromDbPath(std::string path) {
    Path result;
    // first split the nodes
    {
        int nodeEnd;
        for (
            int nodeBegin = path.find_first_not_of('/');
            nodeBegin != std::string::npos;
            nodeBegin = path.find_first_not_of('/', nodeEnd)
        ) {
            nodeEnd = path.find_first_of('/', nodeBegin);

            std::string s = (nodeEnd != std::string::npos) ?
                path.substr(nodeBegin, nodeEnd - nodeBegin) :
                path.substr(nodeBegin);

            for (int i = 0; i < s.length(); i++) if (s.at(i) == '\0') s.at(i) = '/';
            result.appendNode(s);
        }
    }
    return result;
}

Path Path::fromWindowsPath(std::string path) {
    Path result;

    int nodeEnd = 0;

    // first retrieve drive
    if (path.size() >= 2 && path.c_str()[1] == ':') {
        result.setDrive(path.c_str()[0]);
        nodeEnd = 2;
    }

    // split the nodes
    {
        for (
            int nodeBegin = path.find_first_not_of('\\', nodeEnd);
            nodeBegin != std::string::npos;
            nodeBegin = path.find_first_not_of('\\', nodeEnd)
        ) {
            nodeEnd = path.find_first_of('\\', nodeBegin);
            result.appendNode(
                (nodeEnd != std::string::npos) ?
                    path.substr(nodeBegin, nodeEnd - nodeBegin) :
                    path.substr(nodeBegin)
            );
        }
    }

    return result;
}

} // namespace LinuxSampler
1	schoenebeck	1332	/***************************************************************************
2			* *
3			* Copyright (C) 2007 Christian Schoenebeck *
4			* *
5			* This library is free software; you can redistribute it and/or modify *
6			* it under the terms of the GNU General Public License as published by *
7			* the Free Software Foundation; either version 2 of the License, or *
8			* (at your option) any later version. *
9			* *
10			* This library is distributed in the hope that it will be useful, *
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13			* GNU General Public License for more details. *
14			* *
15			* You should have received a copy of the GNU General Public License *
16			* along with this library; if not, write to the Free Software *
17			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
18			* MA 02111-1307 USA *
19			***************************************************************************/
20
21			#include "Path.h"
22
23	schoenebeck	1399	// for function hexsToNumber()
24	schoenebeck	1424	#include "global_private.h"
25	schoenebeck	1399
26	schoenebeck	1471	#include <sstream>
27
28	schoenebeck	1332	namespace LinuxSampler {
29
30	schoenebeck	1471	Path::Path() : drive(0) {
31			}
32
33	schoenebeck	1332	void Path::appendNode(std::string Name) {
34			if (!Name.size()) return;
35			elements.push_back(Name);
36			}
37
38	schoenebeck	1471	void Path::setDrive(const char& Drive) {
39			drive = Drive;
40			}
41
42			std::string Path::toPosix() const {
43	schoenebeck	1332	// POSIX paths consist of forward slash separators and requires forward
44			// slashes in path and file names to be encoded as "%2f", the file names
45			// "." and ".." have special meanings
46			// (see http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap03.html#tag_03_169
47			// and http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap03.html#tag_03_266 )
48			std::string result;
49			for (int iElement = 0; iElement < elements.size(); iElement++) {
50	schoenebeck	1338	// encode percent characters
51	schoenebeck	1332	std::string e = elements[iElement];
52			for (
53	schoenebeck	1338	int pos = e.find("%"); pos != std::string::npos;
54			pos = e.find("%", pos+2)
55			) e.replace(pos/offset/, 1/length/, "%%"/by/);
56			// encode forward slashes
57			for (
58	schoenebeck	1332	int pos = e.find("/"); pos != std::string::npos;
59	schoenebeck	1338	pos = e.find("/", pos+3)
60	schoenebeck	1332	) e.replace(pos/offset/, 1/length/, "%2f"/by/);
61			// append encoded node to full encoded path
62			result += "/" + e;
63			}
64			if (!result.size()) result = "/";
65			return result;
66			}
67
68	schoenebeck	1471	std::string Path::toDbPath() const {
69	iliev	1345	std::string result;
70			for (int iElement = 0; iElement < elements.size(); iElement++) {
71			// replace all slashes with '\0'
72			std::string e = elements[iElement];
73			for (int i = 0; i < e.length(); i++) {
74			if (e.at(i) == '/') e.at(i) = '\0';
75			}
76			// append encoded node to full encoded path
77			result += "/" + e;
78			}
79			if (!result.size()) result = "/";
80			return result;
81			}
82
83	schoenebeck	1471	std::string Path::toLscp() const {
84	schoenebeck	1399	std::string result;
85			for (int iElement = 0; iElement < elements.size(); iElement++) {
86			// replace "special characters" by LSCP escape sequences
87			std::string e = elements[iElement];
88			for (int i = 0; i < e.length(); i++) {
89			const char c = e.c_str()[i];
90			if (
91			!(c >= '0' && c <= '9') &&
92			!(c >= 'a' && c <= 'z') &&
93			!(c >= 'A' && c <= 'Z') &&
94			!(c == '!') && !(c == '#') && !(c == '$') && !(c == '%') &&
95			!(c == '&') && !(c == '(') && !(c == ')') && !(c == '*') &&
96			!(c == '+') && !(c == ',') && !(c == '-') && !(c == '.') &&
97			!(c == ':') && !(c == ';') && !(c == '<') && !(c == '=') &&
98			!(c == '>') && !(c == '?') && !(c == '@') && !(c == '[') &&
99			!(c == ']') && !(c == '^') && !(c == '_') && !(c == '`') &&
100			!(c == '{') && !(c == '\|') && !(c == '}') && !(c == '~')
101			) {
102			// convert the "special" character into a "\xHH" LSCP escape sequence
103			char buf[5];
104			snprintf(buf, sizeof(buf), "\\x%02x", static_cast<unsigned char>(c));
105			e.replace(i, 1, buf);
106			i += 3;
107			}
108			}
109			// append encoded node to full encoded path
110			result += "/" + e;
111			}
112			if (!result.size()) result = "/";
113			return result;
114			}
115
116	schoenebeck	1471	std::string Path::toWindows() const {
117			std::stringstream result;
118			result <<
119			((drive >= 'A' && drive <= 'Z') \|\| (drive >= 'a' && drive <= 'z'))
120			? drive : '?';
121			result << ':';
122			for (int iElement = 0; iElement < elements.size(); iElement++) {
123			// append encoded node to full encoded path
124			result << "\\" << elements[iElement];
125			}
126			return result.str();
127			}
128
129	schoenebeck	1332	Path Path::operator+(const Path& p) {
130			Path result = *this;
131			for (int i = 0; i < p.elements.size(); i++)
132			result.elements.push_back(p.elements[i]);
133			return result;
134			}
135
136			Path Path::operator+(const Path* p) {
137			return this + p;
138			}
139
140	schoenebeck	1399	Path Path::fromPosix(std::string path) {
141			Path result;
142			// first split the nodes
143			{
144			int nodeEnd;
145			for (
146			int nodeBegin = path.find_first_not_of('/');
147			nodeBegin != std::string::npos;
148			nodeBegin = path.find_first_not_of('/', nodeEnd)
149			) {
150			nodeEnd = path.find_first_of('/', nodeBegin);
151			result.appendNode(
152			(nodeEnd != std::string::npos) ?
153			path.substr(nodeBegin, nodeEnd - nodeBegin) :
154			path.substr(nodeBegin)
155			);
156			}
157			}
158			// resolve POSIX escape sequences in all nodes
159			for (int iNode = 0; iNode < result.elements.size(); iNode++) {
160			std::string& s = result.elements[iNode];
161			for (int pos = s.find('%'); pos < s.length(); pos = s.find('%', ++pos)) {
162			if (pos+1 >= s.length()) { // unexpected character
163			//TODO: we might want to throw an exception here, for now we simply replace the character by '?'
164			s.replace(pos, 1, "?");
165			continue;
166			}
167			if (s.c_str()[pos+1] == '%') {
168			s.replace(pos, 2, "%");
169			continue;
170			}
171			if (pos+2 >= s.length()) {
172			//TODO: we might want to throw an exception here, for now we simply replace the character by '?'
173			s.replace(pos, 2, "?");
174			continue;
175			}
176			// expecting a "%HH" sequence here, convert it into the respective character
177			const std::string sHex = s.substr(pos+1, 2);
178			char cAscii = hexsToNumber(sHex.c_str()[1], sHex.c_str()[0]);
179			char pcAscii[] = { cAscii, 0 };
180			s.replace(pos, 3, pcAscii);
181			}
182			}
183			return result;
184			}
185
186	iliev	1403	Path Path::fromDbPath(std::string path) {
187			Path result;
188			// first split the nodes
189			{
190			int nodeEnd;
191			for (
192			int nodeBegin = path.find_first_not_of('/');
193			nodeBegin != std::string::npos;
194			nodeBegin = path.find_first_not_of('/', nodeEnd)
195			) {
196			nodeEnd = path.find_first_of('/', nodeBegin);
197
198			std::string s = (nodeEnd != std::string::npos) ?
199			path.substr(nodeBegin, nodeEnd - nodeBegin) :
200			path.substr(nodeBegin);
201
202			for (int i = 0; i < s.length(); i++) if (s.at(i) == '\0') s.at(i) = '/';
203			result.appendNode(s);
204			}
205			}
206			return result;
207			}
208
209	schoenebeck	1471	Path Path::fromWindowsPath(std::string path) {
210			Path result;
211
212			int nodeEnd = 0;
213
214			// first retrieve drive
215			if (path.size() >= 2 && path.c_str()[1] == ':') {
216			result.setDrive(path.c_str()[0]);
217			nodeEnd = 2;
218			}
219
220			// split the nodes
221			{
222			for (
223			int nodeBegin = path.find_first_not_of('\\', nodeEnd);
224			nodeBegin != std::string::npos;
225			nodeBegin = path.find_first_not_of('\\', nodeEnd)
226			) {
227			nodeEnd = path.find_first_of('\\', nodeBegin);
228			result.appendNode(
229			(nodeEnd != std::string::npos) ?
230			path.substr(nodeBegin, nodeEnd - nodeBegin) :
231			path.substr(nodeBegin)
232			);
233			}
234			}
235
236			return result;
237			}
238
239	schoenebeck	1332	} // namespace LinuxSampler