--- linuxsampler/trunk/src/network/lscpserver.cpp 2007/09/17 23:15:25 1353 +++ linuxsampler/trunk/src/network/lscpserver.cpp 2007/12/03 18:30:47 1537 @@ -25,7 +25,11 @@ #include "lscpresultset.h" #include "lscpevent.h" +#if defined(WIN32) +#include +#else #include +#endif #if ! HAVE_SQLITE3 #define DOESNT_HAVE_SQLITE3 "No database support. SQLITE3 was not installed when linuxsampler was built." @@ -36,6 +40,42 @@ #include "../drivers/audio/AudioOutputDeviceFactory.h" #include "../drivers/midi/MidiInputDeviceFactory.h" + +/** + * Returns a copy of the given string where all special characters are + * replaced by LSCP escape sequences ("\xHH"). This function shall be used + * to escape LSCP response fields in case the respective response field is + * actually defined as using escape sequences in the LSCP specs. + * + * @e Caution: DO NOT use this function for escaping path based responses, + * use the Path class (src/common/Path.h) for this instead! + */ +static String _escapeLscpResponse(String txt) { + for (int i = 0; i < txt.length(); i++) { + const char c = txt.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 == '|') && !(c == '}') && !(c == '~') + ) { + // convert the "special" character into a "\xHH" LSCP escape sequence + char buf[5]; + snprintf(buf, sizeof(buf), "\\x%02x", static_cast(c)); + txt.replace(i, 1, buf); + i += 3; + } + } + return txt; +} + /** * Below are a few static members of the LSCPServer class. * The big assumption here is that LSCPServer is going to remain a singleton. @@ -93,7 +133,11 @@ } LSCPServer::~LSCPServer() { +#if defined(WIN32) + if (hSocket >= 0) closesocket(hSocket); +#else if (hSocket >= 0) close(hSocket); +#endif } void LSCPServer::EventHandler::ChannelCountChanged(int NewCount) { @@ -194,6 +238,15 @@ } int LSCPServer::Main() { + #if defined(WIN32) + WSADATA wsaData; + int iResult; + iResult = WSAStartup(MAKEWORD(2,2), &wsaData); + if (iResult != 0) { + std::cerr << "LSCPServer: WSAStartup failed: " << iResult << "\n"; + exit(EXIT_FAILURE); + } + #endif hSocket = socket(AF_INET, SOCK_STREAM, 0); if (hSocket < 0) { std::cerr << "LSCPServer: Could not create server socket." << std::endl; @@ -207,7 +260,11 @@ if (bind(hSocket, (sockaddr*) &SocketAddress, sizeof(sockaddr_in)) < 0) { if (trial > LSCP_SERVER_BIND_TIMEOUT) { std::cerr << "gave up!" << std::endl; + #if defined(WIN32) + closesocket(hSocket); + #else close(hSocket); + #endif //return -1; exit(EXIT_FAILURE); } @@ -289,7 +346,11 @@ continue; //Nothing try again if (retval == -1) { std::cerr << "LSCPServer: Socket select error." << std::endl; + #if defined(WIN32) + closesocket(hSocket); + #else close(hSocket); + #endif exit(EXIT_FAILURE); } @@ -301,10 +362,18 @@ exit(EXIT_FAILURE); } + #if defined(WIN32) + u_long nonblock_io = 1; + if( ioctlsocket(socket, FIONBIO, &nonblock_io) ) { + std::cerr << "LSCPServer: ioctlsocket: set FIONBIO failed. Error " << WSAGetLastError() << std::endl; + exit(EXIT_FAILURE); + } + #else if (fcntl(socket, F_SETFL, O_NONBLOCK)) { std::cerr << "LSCPServer: F_SETFL O_NONBLOCK failed." << std::endl; exit(EXIT_FAILURE); } + #endif // Parser initialization yyparse_param_t yyparse_param; @@ -363,7 +432,11 @@ NotifyMutex.Lock(); bufferedCommands.erase(socket); bufferedNotifies.erase(socket); + #if defined(WIN32) + closesocket(socket); + #else close(socket); + #endif NotifyMutex.Unlock(); } @@ -442,7 +515,11 @@ char c; int i = 0; while (true) { + #if defined(WIN32) + int result = recv(socket, (char *)&c, 1, 0); //Read one character at a time for now + #else int result = recv(socket, (void *)&c, 1, 0); //Read one character at a time for now + #endif if (result == 0) { //socket was selected, so 0 here means client has closed the connection CloseConnection(iter); break; @@ -457,6 +534,16 @@ } bufferedCommands[socket] += c; } + #if defined(WIN32) + if (result == SOCKET_ERROR) { + int wsa_lasterror = WSAGetLastError(); + if (wsa_lasterror == WSAEWOULDBLOCK) //Would block, try again later. + return false; + dmsg(2,("LSCPScanner: Socket error after recv() Error %d.\n", wsa_lasterror)); + CloseConnection(iter); + break; + } + #else if (result == -1) { if (errno == EAGAIN) //Would block, try again later. return false; @@ -495,6 +582,7 @@ CloseConnection(iter); break; } + #endif } return false; } @@ -768,7 +856,7 @@ LockRTNotify(); try { Engine* pEngine = EngineFactory::Create(EngineName); - result.Add("DESCRIPTION", pEngine->Description()); + result.Add("DESCRIPTION", _escapeLscpResponse(pEngine->Description())); result.Add("VERSION", pEngine->Version()); EngineFactory::Destroy(pEngine); } @@ -841,9 +929,20 @@ if (pSamplerChannel->GetMidiInputChannel() == midi_chan_all) result.Add("MIDI_INPUT_CHANNEL", "ALL"); else result.Add("MIDI_INPUT_CHANNEL", pSamplerChannel->GetMidiInputChannel()); + // convert the filename into the correct encoding as defined for LSCP + // (especially in terms of special characters -> escape sequences) + if (InstrumentFileName != "NONE" && InstrumentFileName != "") { +#if WIN32 + InstrumentFileName = Path::fromWindows(InstrumentFileName).toLscp(); +#else + // assuming POSIX + InstrumentFileName = Path::fromPosix(InstrumentFileName).toLscp(); +#endif + } + result.Add("INSTRUMENT_FILE", InstrumentFileName); result.Add("INSTRUMENT_NR", InstrumentIndex); - result.Add("INSTRUMENT_NAME", InstrumentName); + result.Add("INSTRUMENT_NAME", _escapeLscpResponse(InstrumentName)); result.Add("INSTRUMENT_STATUS", InstrumentStatus); result.Add("MUTE", Mute == -1 ? "MUTED_BY_SOLO" : (Mute ? "true" : "false")); result.Add("SOLO", Solo); @@ -1785,9 +1884,19 @@ std::map::iterator iter = mappings.find(idx); if (iter == mappings.end()) result.Error("there is no map entry with that index"); else { // found - result.Add("NAME", iter->second.Name); + + // convert the filename into the correct encoding as defined for LSCP + // (especially in terms of special characters -> escape sequences) +#if WIN32 + const String instrumentFileName = Path::fromWindows(iter->second.InstrumentFile).toLscp(); +#else + // assuming POSIX + const String instrumentFileName = Path::fromPosix(iter->second.InstrumentFile).toLscp(); +#endif + + result.Add("NAME", _escapeLscpResponse(iter->second.Name)); result.Add("ENGINE_NAME", iter->second.EngineName); - result.Add("INSTRUMENT_FILE", iter->second.InstrumentFile); + result.Add("INSTRUMENT_FILE", instrumentFileName); result.Add("INSTRUMENT_NR", (int) iter->second.InstrumentIndex); String instrumentName; Engine* pEngine = EngineFactory::Create(iter->second.EngineName); @@ -1800,7 +1909,7 @@ } EngineFactory::Destroy(pEngine); } - result.Add("INSTRUMENT_NAME", instrumentName); + result.Add("INSTRUMENT_NAME", _escapeLscpResponse(instrumentName)); switch (iter->second.LoadMode) { case MidiInstrumentMapper::ON_DEMAND: result.Add("LOAD_MODE", "ON_DEMAND"); @@ -1955,7 +2064,7 @@ dmsg(2,("LSCPServer: GetMidiInstrumentMap()\n")); LSCPResultSet result; try { - result.Add("NAME", MidiInstrumentMapper::MapName(MidiMapID)); + result.Add("NAME", _escapeLscpResponse(MidiInstrumentMapper::MapName(MidiMapID))); result.Add("DEFAULT", MidiInstrumentMapper::GetDefaultMap() == MidiMapID); } catch (Exception e) { result.Error(e); @@ -2099,7 +2208,7 @@ } // success - result.Add("NAME", pFxSend->Name()); + result.Add("NAME", _escapeLscpResponse(pFxSend->Name())); result.Add("MIDI_CONTROLLER", pFxSend->MidiController()); result.Add("LEVEL", ToString(pFxSend->Level())); result.Add("AUDIO_OUTPUT_ROUTING", AudioRouting); @@ -2222,8 +2331,10 @@ */ String LSCPServer::GetServerInfo() { dmsg(2,("LSCPServer: GetServerInfo()\n")); + const std::string description = + _escapeLscpResponse("LinuxSampler - modular, streaming capable sampler"); LSCPResultSet result; - result.Add("DESCRIPTION", "LinuxSampler - modular, streaming capable sampler"); + result.Add("DESCRIPTION", description); result.Add("VERSION", VERSION); result.Add("PROTOCOL_VERSION", ToString(LSCP_RELEASE_MAJOR) + "." + ToString(LSCP_RELEASE_MINOR)); #if HAVE_SQLITE3 @@ -2273,6 +2384,166 @@ return result.Produce(); } +String LSCPServer::GetFileInstruments(String Filename) { + dmsg(2,("LSCPServer: GetFileInstruments(String Filename=%s)\n",Filename.c_str())); + LSCPResultSet result; + try { + VerifyFile(Filename); + } catch (Exception e) { + result.Error(e); + return result.Produce(); + } + // try to find a sampler engine that can handle the file + bool bFound = false; + std::vector engineTypes = EngineFactory::AvailableEngineTypes(); + for (int i = 0; !bFound && i < engineTypes.size(); i++) { + Engine* pEngine = NULL; + try { + pEngine = EngineFactory::Create(engineTypes[i]); + if (!pEngine) throw Exception("Internal error: could not create '" + engineTypes[i] + "' engine"); + InstrumentManager* pManager = pEngine->GetInstrumentManager(); + if (pManager) { + std::vector IDs = + pManager->GetInstrumentFileContent(Filename); + // return the amount of instruments in the file + result.Add(IDs.size()); + // no more need to ask other engine types + bFound = true; + } else dmsg(1,("Warning: engine '%s' does not provide an instrument manager\n", engineTypes[i].c_str())); + } catch (Exception e) { + // NOOP, as exception is thrown if engine doesn't support file + } + if (pEngine) EngineFactory::Destroy(pEngine); + } + + if (!bFound) result.Error("Unknown file format"); + return result.Produce(); +} + +String LSCPServer::ListFileInstruments(String Filename) { + dmsg(2,("LSCPServer: ListFileInstruments(String Filename=%s)\n",Filename.c_str())); + LSCPResultSet result; + try { + VerifyFile(Filename); + } catch (Exception e) { + result.Error(e); + return result.Produce(); + } + // try to find a sampler engine that can handle the file + bool bFound = false; + std::vector engineTypes = EngineFactory::AvailableEngineTypes(); + for (int i = 0; !bFound && i < engineTypes.size(); i++) { + Engine* pEngine = NULL; + try { + pEngine = EngineFactory::Create(engineTypes[i]); + if (!pEngine) throw Exception("Internal error: could not create '" + engineTypes[i] + "' engine"); + InstrumentManager* pManager = pEngine->GetInstrumentManager(); + if (pManager) { + std::vector IDs = + pManager->GetInstrumentFileContent(Filename); + // return a list of IDs of the instruments in the file + String s; + for (int j = 0; j < IDs.size(); j++) { + if (s.size()) s += ","; + s += ToString(IDs[j].Index); + } + result.Add(s); + // no more need to ask other engine types + bFound = true; + } else dmsg(1,("Warning: engine '%s' does not provide an instrument manager\n", engineTypes[i].c_str())); + } catch (Exception e) { + // NOOP, as exception is thrown if engine doesn't support file + } + if (pEngine) EngineFactory::Destroy(pEngine); + } + + if (!bFound) result.Error("Unknown file format"); + return result.Produce(); +} + +String LSCPServer::GetFileInstrumentInfo(String Filename, uint InstrumentID) { + dmsg(2,("LSCPServer: GetFileInstrumentInfo(String Filename=%s, InstrumentID=%d)\n",Filename.c_str(),InstrumentID)); + LSCPResultSet result; + try { + VerifyFile(Filename); + } catch (Exception e) { + result.Error(e); + return result.Produce(); + } + InstrumentManager::instrument_id_t id; + id.FileName = Filename; + id.Index = InstrumentID; + // try to find a sampler engine that can handle the file + bool bFound = false; + bool bFatalErr = false; + std::vector engineTypes = EngineFactory::AvailableEngineTypes(); + for (int i = 0; !bFound && !bFatalErr && i < engineTypes.size(); i++) { + Engine* pEngine = NULL; + try { + pEngine = EngineFactory::Create(engineTypes[i]); + if (!pEngine) throw Exception("Internal error: could not create '" + engineTypes[i] + "' engine"); + InstrumentManager* pManager = pEngine->GetInstrumentManager(); + if (pManager) { + // check if the instrument index is valid + // FIXME: this won't work if an engine only supports parts of the instrument file + std::vector IDs = + pManager->GetInstrumentFileContent(Filename); + if (std::find(IDs.begin(), IDs.end(), id) == IDs.end()) { + std::stringstream ss; + ss << "Invalid instrument index " << InstrumentID << " for instrument file '" << Filename << "'"; + bFatalErr = true; + throw Exception(ss.str()); + } + // get the info of the requested instrument + InstrumentManager::instrument_info_t info = + pManager->GetInstrumentInfo(id); + // return detailed informations about the file + result.Add("NAME", info.InstrumentName); + result.Add("FORMAT_FAMILY", engineTypes[i]); + result.Add("FORMAT_VERSION", info.FormatVersion); + result.Add("PRODUCT", info.Product); + result.Add("ARTISTS", info.Artists); + // no more need to ask other engine types + bFound = true; + } else dmsg(1,("Warning: engine '%s' does not provide an instrument manager\n", engineTypes[i].c_str())); + } catch (Exception e) { + // usually NOOP, as exception is thrown if engine doesn't support file + if (bFatalErr) result.Error(e); + } + if (pEngine) EngineFactory::Destroy(pEngine); + } + + if (!bFound && !bFatalErr) result.Error("Unknown file format"); + return result.Produce(); +} + +void LSCPServer::VerifyFile(String Filename) { + #if WIN32 + WIN32_FIND_DATA win32FileAttributeData; + BOOL res = GetFileAttributesEx( Filename.c_str(), GetFileExInfoStandard, &win32FileAttributeData ); + if (!res) { + std::stringstream ss; + ss << "File does not exist, GetFileAttributesEx failed `" << Filename << "`: Error " << GetLastError(); + throw Exception(ss.str()); + } + if ( win32FileAttributeData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY ) { + throw Exception("Directory is specified"); + } + #else + struct stat statBuf; + int res = stat(Filename.c_str(), &statBuf); + if (res) { + std::stringstream ss; + ss << "Fail to stat `" << Filename << "`: " << strerror(errno); + throw Exception(ss.str()); + } + + if (S_ISDIR(statBuf.st_mode)) { + throw Exception("Directory is specified"); + } + #endif +} + /** * Will be called by the parser to subscribe a client (frontend) on the * server for receiving event messages. @@ -2374,7 +2645,7 @@ try { DbDirectory info = InstrumentsDb::GetInstrumentsDb()->GetDirectoryInfo(Dir); - result.Add("DESCRIPTION", InstrumentsDb::toEscapedText(info.Description)); + result.Add("DESCRIPTION", _escapeLscpResponse(info.Description)); result.Add("CREATED", info.Created); result.Add("MODIFIED", info.Modified); } catch (Exception e) { @@ -2558,11 +2829,11 @@ result.Add("SIZE", (int)info.Size); result.Add("CREATED", info.Created); result.Add("MODIFIED", info.Modified); - result.Add("DESCRIPTION", InstrumentsDb::toEscapedText(info.Description)); + result.Add("DESCRIPTION", _escapeLscpResponse(info.Description)); result.Add("IS_DRUM", info.IsDrum); - result.Add("PRODUCT", InstrumentsDb::toEscapedText(info.Product)); - result.Add("ARTISTS", InstrumentsDb::toEscapedText(info.Artists)); - result.Add("KEYWORDS", InstrumentsDb::toEscapedText(info.Keywords)); + result.Add("PRODUCT", _escapeLscpResponse(info.Product)); + result.Add("ARTISTS", _escapeLscpResponse(info.Artists)); + result.Add("KEYWORDS", _escapeLscpResponse(info.Keywords)); } catch (Exception e) { result.Error(e); }