X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxserver.C;h=b6c3e96d28a06ac8e085fe3701900406e0386ee7;hb=8555881d19d77b32315661699fab31a82d3833ab;hp=e5cda8f139790ea23216a96291198ab051acbbd5;hpb=27de1486ca34aaad446adb798d71a77d6f6304da;p=lyx.git diff --git a/src/lyxserver.C b/src/lyxserver.C index e5cda8f139..b6c3e96d28 100644 --- a/src/lyxserver.C +++ b/src/lyxserver.C @@ -1,374 +1,334 @@ -// -*- C++ -*- /* This file is part of * ====================================================== -* -* LyX, The Document Processor -* -* Copyright (C) 1995 Matthias Ettrich -* Copyright (C) 1995-1998 The LyX Team. -* -*======================================================*/ + * + * LyX, The Document Processor + * + * Copyright 1995 Matthias Ettrich + * Copyright 1995-2001 The LyX Team. + * + * ====================================================== */ /** Docu : To use the lyxserver define the name of the pipe in your - lyxrc: - \serverpipe "/home/myhome/.lyxpipe" - Then use .lyxpipe.in and .lyxpipe.out to communicate to LyX. - Each message consists of a single line in ASCII. Input lines - (client -> LyX) have the following format: - "LYXCMD:::" - Answers from LyX look like this: - "INFO:::" + lyxrc: + \serverpipe "/home/myhome/.lyxpipe" + Then use .lyxpipe.in and .lyxpipe.out to communicate to LyX. + Each message consists of a single line in ASCII. Input lines + (client -> LyX) have the following format: + "LYXCMD:::" + Answers from LyX look like this: + "INFO:::" [asierra970531] Or like this in case of error: - "ERROR:::" - where and are just echoed. - If LyX notifies about a user defined extension key-sequence, - the line looks like this: - "NOTIFY:" + "ERROR:::" + where and are just echoed. + If LyX notifies about a user defined extension key-sequence, + the line looks like this: + "NOTIFY:" [asierra970531] New server-only messages to implement a simple protocol - "LYXSRV::" - where can be "hello" or "bye". If hello is - received LyX will inform the client that it's listening its - messages, and 'bye' will inform that lyx is closing. + "LYXSRV::" + where can be "hello" or "bye". If hello is + received LyX will inform the client that it's listening its + messages, and 'bye' will inform that lyx is closing. - See development/server_monitor.c for an example client. + See development/server_monitor.c for an example client. Purpose: implement a client/server lib for LyX */ #include -#include -#include #include #include #include #include -#include -#include FORMS_H_LOCATION +#include #ifdef __GNUG__ #pragma implementation #endif #include "lyxserver.h" -#include "lyxfunc.h" #include "lyx_main.h" -#include "error.h" +#include "debug.h" +#include "lyxfunc.h" +#include "support/lstrings.h" +#include "support/lyxlib.h" +#include "frontends/lyx_gui.h" #ifdef __EMX__ -#include +#include #include #define OS2EMX_PLAIN_CHAR #define INCL_DOSNMPIPES #define INCL_DOSERRORS #include -#include "os2_errortable.h" +#include "support/os2_errortable.h" #endif +using std::endl; + // provide an empty mkfifo() if we do not have one. This disables the -// lyxserver. +// lyxserver. #ifndef HAVE_MKFIFO -int mkfifo( char *__path, mode_t __mode ) { +int mkfifo(char const * __path, mode_t __mode) { return 0; } #endif -// $Id: lyxserver.C,v 1.1 1999/09/27 18:44:38 larsbj Exp $ - -#if !defined(lint) && !defined(WITH_WARNINGS) -static char vcid[] = "$Id: lyxserver.C,v 1.1 1999/09/27 18:44:38 larsbj Exp $"; -#endif /* lint */ - -/* === variables ========================================================= */ - -extern LyXAction lyxaction; +void LyXComm::openConnection() +{ + lyxerr[Debug::LYXSERVER] << "LyXComm: Opening connection" << endl; -// LyXComm class - - // Open pipes -void LyXComm::openConnection() { - lyxerr.debug("LyXComm: Opening connection", Error::LYXSERVER); - // If we are up, that's an error if (ready) { - lyxerr.print("LyXComm: Already connected"); + lyxerr << "LyXComm: Already connected" << endl; return; } // We assume that we don't make it ready = false; - - if (pipename.empty()) return; - // --- prepare input pipe --------------------------------------- - - LString tmp = pipename + ".in"; - + if (pipename.empty()) { + lyxerr[Debug::LYXSERVER] + << "LyXComm: server is disabled, nothing to do" + << endl; + return; + } + + if ((infd = startPipe(inPipeName(), false)) == -1) + return; + + if ((outfd = startPipe(outPipeName(), true)) == -1) { + endPipe(infd, inPipeName(), false); + return; + } + + if (fcntl(outfd, F_SETFL, O_NONBLOCK) < 0) { + lyxerr << "LyXComm: Could not set flags on pipe " << outPipeName() + << '\n' << strerror(errno) << endl; + return; + } + + // We made it! + ready = true; + lyxerr[Debug::LYXSERVER] << "LyXComm: Connection established" << endl; +} + + +/// Close pipes +void LyXComm::closeConnection() +{ + lyxerr[Debug::LYXSERVER] << "LyXComm: Closing connection" << endl; + + if (pipename.empty()) { + lyxerr[Debug::LYXSERVER] + << "LyXComm: server is disabled, nothing to do" + << endl; + return; + } + + if (!ready) { + lyxerr << "LyXComm: Already disconnected" << endl; + return; + } + + endPipe(infd, inPipeName(), false); + endPipe(outfd, outPipeName(), true); + + ready = false; +} + +int LyXComm::startPipe(string const & filename, bool write) +{ + int fd; + #ifdef __EMX__ - HPIPE fd; + HPIPE os2fd; APIRET rc; int errnum; // Try create one instance of named pipe with the mode O_RDONLY|O_NONBLOCK. // The current emx implementation of access() won't work with pipes. - rc = DosCreateNPipe(tmp.c_str(), &fd, NP_ACCESS_INBOUND, + rc = DosCreateNPipe(filename.c_str(), &os2fd, NP_ACCESS_INBOUND, NP_NOWAIT|0x01, 0600, 0600, 0); if (rc == ERROR_PIPE_BUSY) { -#else - if (access(tmp.c_str(), F_OK) == 0) { -#endif - lyxerr.print("LyXComm: Pipe " + tmp + " already exists."); - lyxerr.print("If no other LyX program is active, please delete" - " the pipe by hand and try again."); - pipename = LString(); - return; + lyxerr << "LyXComm: Pipe " << filename << " already exists.\n" + << "If no other LyX program is active, please delete" + " the pipe by hand and try again." << endl; + pipename.erase(); + return -1; } -#ifndef __EMX__ - if (mkfifo(tmp.c_str(), 0600) < 0) { - lyxerr.print("LyXComm: Could not create pipe " + tmp); - lyxerr.print(strerror(errno)); - return; - }; - infd = open(tmp.c_str(), O_RDONLY|O_NONBLOCK); -#else + if (rc != NO_ERROR) { errnum = TranslateOS2Error(rc); - lyxerr.print("LyXComm: Could not create pipe " + tmp); - lyxerr.print(strerror(errnum)); - return; + lyxerr <<"LyXComm: Could not create pipe " << filename + << strerror(errnum) << endl; + return -1; }; // Listen to it. - rc = DosConnectNPipe(fd); + rc = DosConnectNPipe(os2fd); if (rc != NO_ERROR && rc != ERROR_PIPE_NOT_CONNECTED) { errnum = TranslateOS2Error(rc); - lyxerr.print("LyXComm: Could not create pipe " + tmp); - lyxerr.print(strerror(errnum)); - return; + lyxerr <<"LyXComm: Could not create pipe " << filename + << strerror(errnum) << endl; + return -1; }; // Imported handles can be used both with OS/2 APIs and emx - // library functions. - infd = _imphandle(fd); -#endif - if (infd < 0) { - lyxerr.print("LyXComm: Could not open pipe " + tmp); - lyxerr.print(strerror(errno)); - return; - } - fl_add_io_callback(infd, FL_READ, callback, (void*)this); - - // --- prepare output pipe --------------------------------------- - - tmp = pipename + ".out"; - -#ifndef __EMX__ - if (access(tmp.c_str(), F_OK) == 0) { + // library functions. + fd = _imphandle(os2fd); #else - rc = DosCreateNPipe(tmp.c_str(), &fd, NP_ACCESS_DUPLEX, - NP_NOWAIT|0x01, 0600, 0600, 0); - - if (rc == ERROR_PIPE_BUSY) { -#endif - lyxerr.print("LyXComm: Pipe " + tmp + " already exists."); - lyxerr.print("If no other LyX program is active, please delete" - " the pipe by hand and try again."); - pipename = LString(); - return; + if (::access(filename.c_str(), F_OK) == 0) { + lyxerr << "LyXComm: Pipe " << filename << " already exists.\n" + << "If no other LyX program is active, please delete" + " the pipe by hand and try again." << endl; + pipename.erase(); + return -1; } -#ifndef __EMX__ - if (mkfifo(tmp.c_str(), 0600) < 0) { - lyxerr.print("LyXComm: Could not create pipe " + tmp); - lyxerr.print(strerror(errno)); - return; + + if (::mkfifo(filename.c_str(), 0600) < 0) { + lyxerr << "LyXComm: Could not create pipe " << filename << '\n' + << strerror(errno) << endl; + return -1; }; - if (access(tmp.c_str(), F_OK) != 0) { - lyxerr.print("LyXComm: Pipe " + tmp + " does not exist"); - return; - } - outfd = open(tmp.c_str(), O_RDWR); -#else - if (rc != NO_ERROR) { - errnum = TranslateOS2Error(rc); - lyxerr.print("LyXComm: Could not create pipe " + tmp); - lyxerr.print(strerror(errnum)); - return; - } - rc = DosConnectNPipe(fd); - if (rc == ERROR_BAD_PIPE) { - lyxerr.print("LyXComm: Pipe " + tmp + " does not exist"); - return; + fd = ::open(filename.c_str(), write ? (O_RDWR) : (O_RDONLY|O_NONBLOCK)); +#endif + + if (fd < 0) { + lyxerr << "LyXComm: Could not open pipe " << filename << '\n' + << strerror(errno) << endl; + lyx::unlink(filename); + return -1; } - if (rc != NO_ERROR && rc != ERROR_PIPE_NOT_CONNECTED) { - errnum = TranslateOS2Error(rc); - lyxerr.print("LyXComm: Could not create pipe " + tmp); - lyxerr.print(strerror(errnum)); - return; + + if (!write) { + lyx_gui::set_read_callback(fd, this); } - outfd = _imphandle(fd); -#endif - if (outfd < 0) { - lyxerr.print("LyXComm: Could not open pipe " + tmp); - lyxerr.print(strerror(errno)); + + return fd; +} + + +void LyXComm::endPipe(int & fd, string const & filename, bool write) +{ + if (fd < 0) return; + + if (!write) { + lyx_gui::remove_read_callback(fd); } - if (fcntl(outfd, F_SETFL, O_NONBLOCK) < 0) { - lyxerr.print("LyXComm: Could not set flags on pipe " + tmp); - lyxerr.print(strerror(errno)); - return; - }; - // We made it! - ready = true; - lyxerr.debug("LyXComm: Connection established", Error::LYXSERVER); -} -/// Close pipes -void LyXComm::closeConnection() { #ifdef __EMX__ APIRET rc; int errnum; -#endif - lyxerr.debug("LyXComm: Closing connection", Error::LYXSERVER); - if (pipename.empty()) { - return; - } - - if (!ready) { - lyxerr.print("LyXComm: Already disconnected"); + rc = DosDisConnectNPipe(fd); + if (rc != NO_ERROR) { + errnum = TranslateOS2Error(rc); + lyxerr << "LyXComm: Could not disconnect pipe " << filename + << '\n' << strerror(errnum) << endl; return; } - - if(infd > -1) { - fl_remove_io_callback(infd, FL_READ, callback); - - LString tmp = pipename + ".in"; -#ifdef __EMX__ // Notify the operating system. - rc = DosDisConnectNPipe(infd); - if (rc != NO_ERROR) { - errnum = TranslateOS2Error(rc); - lyxerr.print("LyXComm: Could not disconnect pipe " + tmp); - lyxerr.print(strerror(errnum)); - return; - } -#endif - if (close(infd) < 0) { - lyxerr.print("LyXComm: Could not close pipe " + tmp); - lyxerr.print(strerror(errno)); - } -#ifndef __EMX__ // OS/2 named pipes will be automatically removed. - if (unlink(tmp.c_str()) < 0){ - lyxerr.print("LyXComm: Could not remove pipe " + tmp); - lyxerr.print(strerror(errno)); - }; #endif + + if (::close(fd) < 0) { + lyxerr << "LyXComm: Could not close pipe " << filename + << '\n' << strerror(errno) << endl; } - if(outfd > -1) { - LString tmp = pipename + ".out"; -#ifdef __EMX__ - rc = DosDisConnectNPipe(outfd); - if (rc != NO_ERROR) { - errnum = TranslateOS2Error(rc); - lyxerr.print("LyXComm: Could not disconnect pipe " + tmp); - lyxerr.print(strerror(errnum)); - return; - } -#endif - if (close(outfd) < 0) { - lyxerr.print("LyXComm: Could not close pipe " + tmp); - lyxerr.print(strerror(errno)); - } + +// OS/2 pipes are deleted automatically #ifndef __EMX__ - if (unlink(tmp.c_str()) < 0){ - lyxerr.print("LyXComm: Could not remove pipe " + tmp); - lyxerr.print(strerror(errno)); - }; + if (lyx::unlink(filename) < 0) { + lyxerr << "LyXComm: Could not remove pipe " << filename + << '\n' << strerror(errno) << endl; + }; #endif + + fd = -1; +} + + +void LyXComm::emergencyCleanup() +{ + if (!pipename.empty()) { + endPipe(infd, inPipeName(), false); + endPipe(outfd, outPipeName(), true); } - ready = false; } - + + // Receives messages and sends then to client -void LyXComm::callback(int fd, void *v) +void LyXComm::read_ready() { - LyXComm * c = (LyXComm *) v; - - if (lyxerr.debugging(Error::LYXSERVER)) { - lyxerr.print(LString("LyXComm: Receiving from fd ") + int(fd)); - } - - const int CMDBUFLEN = 100; - char charbuf[CMDBUFLEN]; - LString cmd; -// nb! make lsbuf a class-member for multiple sessions - static LString lsbuf; + // nb! make read_buffer_ a class-member for multiple sessions + static string read_buffer_; + read_buffer_.erase(); + + int const charbuf_size = 100; + char charbuf[charbuf_size]; errno = 0; int status; // the single = is intended here. - while((status = read(fd,charbuf,CMDBUFLEN-1))) - {// break and return in loop - if(status > 0) // got something - { - charbuf[status]='\0'; // turn it into a c string - lsbuf += charbuf; - lsbuf.strip('\r'); - // commit any commands read - while(lsbuf.charPos('\n') >= 0) // while still - // commands - // left - { - // split() grabs the entire string if - // the delim /wasn't/ found. ?:-P - lsbuf.split(cmd,'\n'); - lyxerr.debug(LString("LyXComm: status:") - + status + ", lsbuf:" + lsbuf - + ", cmd:" + cmd, - Error::LYXSERVER); - if(!cmd.empty()) - c->clientcb(c->client, cmd); - //\n or not \n? - } - } - if(errno == EAGAIN) - { // EAGAIN is not really an error , it means we're - // only reading too fast for the writing process on - // the other end of the pipe. - errno = 0; - return; // up to libforms select-loop (*crunch*) - } - if(errno != 0 ) - { - lyxerr.print(LString("LyXComm: ") + strerror(errno)); - if(!lsbuf.empty()) - { - lyxerr.print("LyxComm: truncated command: " - + lsbuf); - lsbuf.clean(); + while ((status = ::read(infd, charbuf, charbuf_size - 1))) { + + if (status > 0) { + charbuf[status] = '\0'; // turn it into a c string + read_buffer_ += rtrim(charbuf, "\r"); + + } else if (errno != EAGAIN) { + if (!read_buffer_.empty()) { + lyxerr << "LyXComm: truncated command: " + << read_buffer_ << '\n' + << "Resetting connection" << endl; + read_buffer_.erase(); } - break; // reset connection + + // reset connection + closeConnection(); + openConnection(); + break; + + } else { + // errno == EAGAIN + // Nothing new has arrived, so now's the time + // to tell the outside world if there's anything + // in the read buffer. + break; } } - c->closeConnection(); - c->openConnection(); - errno=0; + + if (!read_buffer_.empty()) { + read_buffer_ = rtrim(read_buffer_, "\n"); + lyxerr[Debug::LYXSERVER] + << "LyXComm: Received from fd " + << infd << '\n' + << '\"' << read_buffer_ << '\"' << endl; + clientcb(client, read_buffer_); + } + + errno = 0; } - -void LyXComm::send(LString const & msg) { + + +void LyXComm::send(string const & msg) +{ if (msg.empty()) { - lyxerr.print("LyXComm: Request to send empty string. Ignoring."); + lyxerr << "LyXComm: Request to send empty string. Ignoring." + << endl; return; } - if (lyxerr.debugging(Error::LYXSERVER)) { - lyxerr.print("LyXComm: Sending '" + msg + '\''); + if (lyxerr.debugging(Debug::LYXSERVER)) { + lyxerr << "LyXComm: Sending '" << msg << '\'' << endl; } if (pipename.empty()) return; if (!ready) { - lyxerr.print("LyXComm: Pipes are closed. Could not send "+ msg); - } else if (write(outfd, msg.c_str(), msg.length()) < 0) { - lyxerr.print("LyXComm: Error sending message: " + msg); - lyxerr.print(strerror(errno)); - lyxerr.print("LyXComm: Resetting connection"); + lyxerr << "LyXComm: Pipes are closed. Could not send " + << msg << endl; + } else if (::write(outfd, msg.c_str(), msg.length()) < 0) { + lyxerr << "LyXComm: Error sending message: " << msg + << '\n' << strerror(errno) + << "\nLyXComm: Resetting connection" << endl; closeConnection(); openConnection(); } @@ -378,8 +338,8 @@ void LyXComm::send(LString const & msg) { rc = DosResetBuffer(outfd); // To avoid synchronization problems. if (rc != NO_ERROR) { errnum = TranslateOS2Error(rc); - lyxerr.print("LyXComm: Message could not be flushed: " +msg); - lyxerr.print(strerror(errnum)); + lyxerr << "LyXComm: Message could not be flushed: " << msg + << '\n' << strerror(errnum) << endl; } #endif } @@ -392,8 +352,8 @@ LyXServer::~LyXServer() // say goodbye to clients so they stop sending messages // modified june 1999 by stefano@zool.su.se to send as many bye // messages as there are clients, each with client's name. - LString message; - for (int i=0; i::\n // bool server_only = false; - while(*p) { + while (*p) { // --- 1. check 'header' --- - if (strncmp(p, "LYXSRV:", 7)==0) { - server_only = true; - } else if(0!=strncmp(p, "LYXCMD:", 7)) { - lyxerr.print("LyXServer: Unknown request"); + + if (compare(p, "LYXSRV:", 7) == 0) { + server_only = true; + } else if (0 != compare(p, "LYXCMD:", 7)) { + lyxerr << "LyXServer: Unknown request \"" << p << "\"" << endl; return; } p += 7; - + // --- 2. for the moment ignore the client name --- - LString client; - while(*p && *p != ':') + string client; + while (*p && *p != ':') client += char(*p++); - if(*p == ':') p++; - if(!*p) return; - + if (*p == ':') ++p; + if (!*p) return; + // --- 3. get function name --- - LString cmd; - while(*p && *p != ':') + string cmd; + while (*p && *p != ':') cmd += char(*p++); - + // --- 4. parse the argument --- - LString arg; - if(!server_only && *p == ':' && *(++p)) { - while(*p && *p != '\n') + string arg; + if (!server_only && *p == ':' && *(++p)) { + while (*p && *p != '\n') arg += char(*p++); - if(*p) p++; + if (*p) ++p; } - - lyxerr.debug("LyXServer: Client: '" + client + "' Command: '" + cmd + "' Argument: '" + arg + '\'', Error::LYXSERVER); - + + lyxerr[Debug::LYXSERVER] + << "LyXServer: Client: '" << client + << "' Command: '" << cmd + << "' Argument: '" << arg << '\'' << endl; + // --- lookup and exec the command ------------------ - + if (server_only) { - LString buf; - // return the greeting to inform the client that + string buf; + // return the greeting to inform the client that // we are listening. if (cmd == "hello") { // One more client - if(serv->numclients==MAX_CLIENTS){ //paranoid check - lyxerr.debug("LyXServer: too many clients...", Error::LYXSERVER); + if (serv->numclients == MAX_CLIENTS) { //paranoid check + lyxerr[Debug::LYXSERVER] + << "LyXServer: too many clients..." + << endl; return; } - int i=0; //find place in clients[] - while (!serv->clients[i].empty() - && inumclients) - i++; + int i= 0; //find place in clients[] + while (!serv->clients[i].empty() + && inumclients) + ++i; serv->clients[i] = client; serv->numclients++; buf = "LYXSRV:" + client + ":hello\n"; - lyxerr.debug("LyXServer: Greeting " + client, Error::LYXSERVER); + lyxerr[Debug::LYXSERVER] + << "LyXServer: Greeting " + << client << endl; serv->pipes.send(buf); } else if (cmd == "bye") { - // If clients==0 maybe we should reset the pipes + // If clients == 0 maybe we should reset the pipes // to prevent fake callbacks - int i; //look if client is registered - for (i=0; inumclients; i++) { + int i = 0; //look if client is registered + for (; i < serv->numclients; ++i) { if (serv->clients[i] == client) break; } - if (inumclients) { + if (i < serv->numclients) { serv->numclients--; - serv->clients[i].clean(); - lyxerr.debug("LyXServer: Client " + client + " said goodbye", - Error::LYXSERVER); + serv->clients[i].erase(); + lyxerr[Debug::LYXSERVER] + << "LyXServer: Client " + << client << " said goodbye" + << endl; } else { - lyxerr.debug("LyXServer: ignoring bye messge from unregistered client" + - client + "\n", Error::LYXSERVER); + lyxerr[Debug::LYXSERVER] + << "LyXServer: ignoring bye messge from unregistered client" + << client << endl; } } else { - lyxerr.print("LyXServer: Undefined server command " + cmd + "."); + lyxerr <<"LyXServer: Undefined server command " + << cmd << "." << endl; } return; } - + if (!cmd.empty()) { // which lyxfunc should we let it connect to? // The correct solution would be to have a @@ -500,25 +473,20 @@ void LyXServer::callback(LyXServer * serv, LString const & msg) // connect to the lyxfunc in the single LyXView we // support currently. (Lgb) - int action = lyxaction.LookupFunc(cmd.c_str()); - //int action = -1; - LString rval, buf; - - if (action>=0) { - rval = serv->func->Dispatch(action, arg.c_str()); - } else { - rval = "Unknown command"; - } - //modified june 1999 stefano@zool.su.se: + serv->func->dispatch(cmd + ' ' + arg); + string const rval = serv->func->getMessage(); + + //modified june 1999 stefano@zool.su.se: //all commands produce an INFO or ERROR message //in the output pipe, even if they do not return //anything. See chapter 4 of Customization doc. - if (action<0 || serv->func->errorStat()) + string buf; + if (serv->func->errorStat()) buf = "ERROR:"; else buf = "INFO:"; - buf += LString(client) + ":" + cmd + ":" + rval + "\n"; + buf += client + ":" + cmd + ":" + rval + "\n"; serv->pipes.send(buf); // !!! we don't do any error checking - @@ -526,7 +494,7 @@ void LyXServer::callback(LyXServer * serv, LString const & msg) // message is lost and others too // maybe; so the client should empty // the outpipe before issuing a request. - + // not found } } /* while *p */ @@ -534,16 +502,15 @@ void LyXServer::callback(LyXServer * serv, LString const & msg) /* ---F+------------------------------------------------------------------ *\ - Function : LyxNotifyClient + Function : LyXNotifyClient Called by : WorkAreaKeyPress Purpose : send a notify messge to a client Parameters: s - string to send Returns : nothing \* ---F------------------------------------------------------------------- */ -void LyXServer::notifyClient(LString const & s) +void LyXServer::notifyClient(string const & s) { - LString buf = LString("NOTIFY:") + s + "\n"; + string buf = string("NOTIFY:") + s + "\n"; pipes.send(buf); } -