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;
    #if WIN32
    if(drive) {
        result.assign(&drive,1);
        result += ":";
    }
    #endif
    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;
        const char cDrive =
            ((drive >= 'A' && drive <= 'Z') || (drive >= 'a' && drive <= 'z'))
            ? drive : '?';
    result << cDrive;
    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::fromWindows(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	senoner	1537	#if WIN32
86			if(drive) {
87			result.assign(&drive,1);
88			result += ":";
89			}
90			#endif
91	schoenebeck	1399	for (int iElement = 0; iElement < elements.size(); iElement++) {
92			// replace "special characters" by LSCP escape sequences
93			std::string e = elements[iElement];
94			for (int i = 0; i < e.length(); i++) {
95			const char c = e.c_str()[i];
96			if (
97			!(c >= '0' && c <= '9') &&
98			!(c >= 'a' && c <= 'z') &&
99			!(c >= 'A' && c <= 'Z') &&
100			!(c == '!') && !(c == '#') && !(c == '$') && !(c == '%') &&
101			!(c == '&') && !(c == '(') && !(c == ')') && !(c == '*') &&
102			!(c == '+') && !(c == ',') && !(c == '-') && !(c == '.') &&
103			!(c == ':') && !(c == ';') && !(c == '<') && !(c == '=') &&
104			!(c == '>') && !(c == '?') && !(c == '@') && !(c == '[') &&
105			!(c == ']') && !(c == '^') && !(c == '_') && !(c == '`') &&
106			!(c == '{') && !(c == '\|') && !(c == '}') && !(c == '~')
107			) {
108			// convert the "special" character into a "\xHH" LSCP escape sequence
109			char buf[5];
110			snprintf(buf, sizeof(buf), "\\x%02x", static_cast<unsigned char>(c));
111			e.replace(i, 1, buf);
112			i += 3;
113			}
114			}
115			// append encoded node to full encoded path
116			result += "/" + e;
117			}
118			if (!result.size()) result = "/";
119			return result;
120			}
121
122	schoenebeck	1471	std::string Path::toWindows() const {
123			std::stringstream result;
124	senoner	1481	const char cDrive =
125			((drive >= 'A' && drive <= 'Z') \|\| (drive >= 'a' && drive <= 'z'))
126	schoenebeck	1471	? drive : '?';
127	senoner	1481	result << cDrive;
128	schoenebeck	1471	result << ':';
129			for (int iElement = 0; iElement < elements.size(); iElement++) {
130			// append encoded node to full encoded path
131			result << "\\" << elements[iElement];
132			}
133			return result.str();
134			}
135
136	schoenebeck	1332	Path Path::operator+(const Path& p) {
137			Path result = *this;
138			for (int i = 0; i < p.elements.size(); i++)
139			result.elements.push_back(p.elements[i]);
140			return result;
141			}
142
143			Path Path::operator+(const Path* p) {
144			return this + p;
145			}
146
147	schoenebeck	1399	Path Path::fromPosix(std::string path) {
148			Path result;
149			// first split the nodes
150			{
151			int nodeEnd;
152			for (
153			int nodeBegin = path.find_first_not_of('/');
154			nodeBegin != std::string::npos;
155			nodeBegin = path.find_first_not_of('/', nodeEnd)
156			) {
157			nodeEnd = path.find_first_of('/', nodeBegin);
158			result.appendNode(
159			(nodeEnd != std::string::npos) ?
160			path.substr(nodeBegin, nodeEnd - nodeBegin) :
161			path.substr(nodeBegin)
162			);
163			}
164			}
165			// resolve POSIX escape sequences in all nodes
166			for (int iNode = 0; iNode < result.elements.size(); iNode++) {
167			std::string& s = result.elements[iNode];
168			for (int pos = s.find('%'); pos < s.length(); pos = s.find('%', ++pos)) {
169			if (pos+1 >= s.length()) { // unexpected character
170			//TODO: we might want to throw an exception here, for now we simply replace the character by '?'
171			s.replace(pos, 1, "?");
172			continue;
173			}
174			if (s.c_str()[pos+1] == '%') {
175			s.replace(pos, 2, "%");
176			continue;
177			}
178			if (pos+2 >= s.length()) {
179			//TODO: we might want to throw an exception here, for now we simply replace the character by '?'
180			s.replace(pos, 2, "?");
181			continue;
182			}
183			// expecting a "%HH" sequence here, convert it into the respective character
184			const std::string sHex = s.substr(pos+1, 2);
185			char cAscii = hexsToNumber(sHex.c_str()[1], sHex.c_str()[0]);
186			char pcAscii[] = { cAscii, 0 };
187			s.replace(pos, 3, pcAscii);
188			}
189			}
190			return result;
191			}
192
193	iliev	1403	Path Path::fromDbPath(std::string path) {
194			Path result;
195			// first split the nodes
196			{
197			int nodeEnd;
198			for (
199			int nodeBegin = path.find_first_not_of('/');
200			nodeBegin != std::string::npos;
201			nodeBegin = path.find_first_not_of('/', nodeEnd)
202			) {
203			nodeEnd = path.find_first_of('/', nodeBegin);
204
205			std::string s = (nodeEnd != std::string::npos) ?
206			path.substr(nodeBegin, nodeEnd - nodeBegin) :
207			path.substr(nodeBegin);
208
209			for (int i = 0; i < s.length(); i++) if (s.at(i) == '\0') s.at(i) = '/';
210			result.appendNode(s);
211			}
212			}
213			return result;
214			}
215
216	senoner	1481	Path Path::fromWindows(std::string path) {
217	schoenebeck	1471	Path result;
218
219			int nodeEnd = 0;
220
221			// first retrieve drive
222			if (path.size() >= 2 && path.c_str()[1] == ':') {
223			result.setDrive(path.c_str()[0]);
224			nodeEnd = 2;
225			}
226
227			// split the nodes
228			{
229			for (
230			int nodeBegin = path.find_first_not_of('\\', nodeEnd);
231			nodeBegin != std::string::npos;
232			nodeBegin = path.find_first_not_of('\\', nodeEnd)
233			) {
234			nodeEnd = path.find_first_of('\\', nodeBegin);
235			result.appendNode(
236			(nodeEnd != std::string::npos) ?
237			path.substr(nodeBegin, nodeEnd - nodeBegin) :
238			path.substr(nodeBegin)
239			);
240			}
241			}
242
243			return result;
244			}
245
246	schoenebeck	1332	} // namespace LinuxSampler