-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
+/**
+ * \file lyxserver.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author Angus Leeming
+ * \author John Levon
*
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
/**
Docu : To use the lyxserver define the name of the pipe in your
#include <config.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <cerrno>
-#include FORMS_H_LOCATION
-
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "lyxserver.h"
-#include "lyx_main.h"
#include "debug.h"
+#include "funcrequest.h"
+#include "LyXAction.h"
#include "lyxfunc.h"
+#include "frontends/Application.h"
+
+#include "support/filename.h"
#include "support/lstrings.h"
#include "support/lyxlib.h"
-#ifdef __EMX__
-#include <cstdlib>
-#include <io.h>
-#define OS2EMX_PLAIN_CHAR
-#define INCL_DOSNMPIPES
-#define INCL_DOSERRORS
-#include <os2.h>
-#include "support/os2_errortable.h"
+#include <boost/bind.hpp>
+
+#include <cerrno>
+#ifdef HAVE_SYS_STAT_H
+# include <sys/stat.h>
#endif
+#include <fcntl.h>
+
+
+namespace lyx {
+
+using support::compare;
+using support::FileName;
+using support::rtrim;
+using support::split;
+using support::unlink;
using std::endl;
+using std::string;
-// provide an empty mkfifo() if we do not have one. This disables the
-// lyxserver.
-#ifndef HAVE_MKFIFO
-int mkfifo(char const * __path, mode_t __mode) {
- return 0;
-}
-#endif
+#if !defined (HAVE_MKFIFO)
+// We provide a stub class that disables the lyxserver.
-/* === variables ========================================================= */
+void LyXComm::openConnection()
+{}
-extern "C" {
- // C wrapper
- static
- void C_LyXComm_callback(int fd, void *v)
- {
- LyXComm::callback(fd, v);
- }
+void LyXComm::closeConnection()
+{}
+
+int LyXComm::startPipe(string const & filename, bool write)
+{
+ return -1;
}
-// LyXComm class
+void LyXComm::endPipe(int & fd, string const & filename, bool write)
+{}
+
+
+void LyXComm::emergencyCleanup()
+{}
+
+void LyXComm::read_ready()
+{}
+
+
+void LyXComm::send(string const & msg)
+{}
+
+
+#else // defined (HAVE_MKFIFO)
+
-// Open pipes
void LyXComm::openConnection()
{
- lyxerr[Debug::LYXSERVER] << "LyXComm: Opening connection" << endl;
+ LYXERR(Debug::LYXSERVER) << "LyXComm: Opening connection" << endl;
// If we are up, that's an error
if (ready) {
ready = false;
if (pipename.empty()) {
- lyxerr[Debug::LYXSERVER]
+ LYXERR(Debug::LYXSERVER)
<< "LyXComm: server is disabled, nothing to do"
<< endl;
return;
return;
if ((outfd = startPipe(outPipeName(), true)) == -1) {
- endPipe(infd, inPipeName());
+ endPipe(infd, inPipeName(), false);
return;
}
// We made it!
ready = true;
- lyxerr[Debug::LYXSERVER] << "LyXComm: Connection established" << endl;
+ LYXERR(Debug::LYXSERVER) << "LyXComm: Connection established" << endl;
}
/// Close pipes
void LyXComm::closeConnection()
{
- lyxerr[Debug::LYXSERVER] << "LyXComm: Closing connection" << endl;
+ LYXERR(Debug::LYXSERVER) << "LyXComm: Closing connection" << endl;
if (pipename.empty()) {
- lyxerr[Debug::LYXSERVER]
+ LYXERR(Debug::LYXSERVER)
<< "LyXComm: server is disabled, nothing to do"
<< endl;
return;
return;
}
- endPipe(infd, inPipeName());
- endPipe(outfd, outPipeName());
+ endPipe(infd, inPipeName(), false);
+ endPipe(outfd, outPipeName(), true);
ready = false;
}
-int LyXComm::startPipe(string const & filename, bool write)
-{
- int fd;
-
-#ifdef __EMX__
- 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(filename.c_str(), &os2fd, NP_ACCESS_INBOUND,
- NP_NOWAIT|0x01, 0600, 0600, 0);
- if (rc == ERROR_PIPE_BUSY) {
- 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;
- }
- if (rc != NO_ERROR) {
- errnum = TranslateOS2Error(rc);
- lyxerr <<"LyXComm: Could not create pipe " << filename
- << strerror(errnum) << endl;
- return -1;
- };
- // Listen to it.
- rc = DosConnectNPipe(os2fd);
- if (rc != NO_ERROR && rc != ERROR_PIPE_NOT_CONNECTED) {
- errnum = TranslateOS2Error(rc);
- 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.
- fd = _imphandle(os2fd);
-#else
- if (::access(filename.c_str(), F_OK) == 0) {
+int LyXComm::startPipe(string const & file, bool write)
+{
+ FileName const filename(file);
+ if (::access(filename.toFilesystemEncoding().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;
return -1;
}
- if (::mkfifo(filename.c_str(), 0600) < 0) {
+ if (::mkfifo(filename.toFilesystemEncoding().c_str(), 0600) < 0) {
lyxerr << "LyXComm: Could not create pipe " << filename << '\n'
<< strerror(errno) << endl;
return -1;
};
- fd = ::open(filename.c_str(), write ? (O_RDWR) : (O_RDONLY|O_NONBLOCK));
-#endif
+ int const fd = ::open(filename.toFilesystemEncoding().c_str(),
+ write ? (O_RDWR) : (O_RDONLY|O_NONBLOCK));
if (fd < 0) {
lyxerr << "LyXComm: Could not open pipe " << filename << '\n'
<< strerror(errno) << endl;
- lyx::unlink(filename);
+ unlink(filename);
return -1;
}
- if (!write)
- fl_add_io_callback(fd, FL_READ, C_LyXComm_callback, this);
+ if (!write) {
+ theApp()->registerSocketCallback(fd,
+ boost::bind(&LyXComm::read_ready, this));
+ }
return fd;
}
-void LyXComm::endPipe(int & fd, string const & filename)
+void LyXComm::endPipe(int & fd, string const & filename, bool write)
{
if (fd < 0)
return;
-#ifdef __EMX__
- APIRET rc;
- int errnum;
-
- rc = DosDisConnectNPipe(fd);
- if (rc != NO_ERROR) {
- errnum = TranslateOS2Error(rc);
- lyxerr << "LyXComm: Could not disconnect pipe " << filename
- << '\n' << strerror(errnum) << endl;
- return;
+ if (!write) {
+ theApp()->unregisterSocketCallback(fd);
}
-#endif
if (::close(fd) < 0) {
lyxerr << "LyXComm: Could not close pipe " << filename
<< '\n' << strerror(errno) << endl;
}
-// OS/2 pipes are deleted automatically
-#ifndef __EMX__
- if (lyx::unlink(filename) < 0) {
+ if (unlink(FileName(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());
- endPipe(outfd, outPipeName());
+ endPipe(infd, inPipeName(), false);
+ endPipe(outfd, outPipeName(), true);
}
}
// Receives messages and sends then to client
-void LyXComm::callback(int fd, void *v)
+void LyXComm::read_ready()
{
- LyXComm * c = static_cast<LyXComm*>(v);
-
- if (lyxerr.debugging(Debug::LYXSERVER)) {
- lyxerr << "LyXComm: Receiving from fd " << fd << endl;
- }
+ // nb! make read_buffer_ a class-member for multiple sessions
+ static string read_buffer_;
+ read_buffer_.erase();
- const int CMDBUFLEN = 100;
- char charbuf[CMDBUFLEN];
- string cmd;
-// nb! make lsbuf a class-member for multiple sessions
- static string lsbuf;
+ 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 += strip(charbuf, '\r');
+ 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");
// commit any commands read
- while (lsbuf.find('\n') != string::npos) // while still
- // commands
- // left
- {
+ while (read_buffer_.find('\n') != string::npos) {
// split() grabs the entire string if
// the delim /wasn't/ found. ?:-P
- lsbuf= split(lsbuf, cmd,'\n');
- lyxerr[Debug::LYXSERVER]
+ string cmd;
+ read_buffer_= split(read_buffer_, cmd,'\n');
+ LYXERR(Debug::LYXSERVER)
<< "LyXComm: status:" << status
- << ", lsbuf:" << lsbuf
+ << ", read_buffer_:" << read_buffer_
<< ", cmd:" << cmd << endl;
if (!cmd.empty())
- c->clientcb(c->client, cmd);
+ clientcb(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.
+ if (errno == EAGAIN) {
errno = 0;
- return; // up to libforms select-loop (*crunch*)
+ return;
}
- if (errno != 0)
- {
+ if (errno != 0) {
lyxerr << "LyXComm: " << strerror(errno) << endl;
- if (!lsbuf.empty())
- {
- lyxerr << "LyxComm: truncated command: "
- << lsbuf << endl;
- lsbuf.erase();
+ if (!read_buffer_.empty()) {
+ lyxerr << "LyXComm: truncated command: "
+ << read_buffer_ << endl;
+ read_buffer_.erase();
}
break; // reset connection
}
}
- c->closeConnection();
- c->openConnection();
- errno= 0;
+
+ // The connection gets reset in errno != EAGAIN
+ // Why does it need to be reset if errno == 0?
+ closeConnection();
+ openConnection();
+ errno = 0;
}
return;
}
- if (lyxerr.debugging(Debug::LYXSERVER)) {
- lyxerr << "LyXComm: Sending '" << msg << '\'' << endl;
- }
+ LYXERR(Debug::LYXSERVER) << "LyXComm: Sending '" << msg << '\'' << endl;
if (pipename.empty()) return;
closeConnection();
openConnection();
}
-#ifdef __EMX__
- APIRET rc;
- int errnum;
- rc = DosResetBuffer(outfd); // To avoid synchronization problems.
- if (rc != NO_ERROR) {
- errnum = TranslateOS2Error(rc);
- lyxerr << "LyXComm: Message could not be flushed: " << msg
- << '\n' << strerror(errnum) << endl;
- }
-#endif
+}
+
+#endif // defined (HAVE_MKFIFO)
+
+
+string const LyXComm::inPipeName() const
+{
+ return pipename + string(".in");
+}
+
+
+string const LyXComm::outPipeName() const
+{
+ return pipename + string(".out");
}
void LyXServer::callback(LyXServer * serv, string const & msg)
{
- lyxerr[Debug::LYXSERVER] << "LyXServer: Received: '"
+ LYXERR(Debug::LYXSERVER) << "LyXServer: Received: '"
<< msg << '\'' << endl;
char const * p = msg.c_str();
if (compare(p, "LYXSRV:", 7) == 0) {
server_only = true;
} else if (0 != compare(p, "LYXCMD:", 7)) {
- lyxerr << "LyXServer: Unknown request \"" << p << "\"" << endl;
+ lyxerr << "LyXServer: Unknown request \""
+ << p << '"' << endl;
return;
}
p += 7;
if (*p) ++p;
}
- lyxerr[Debug::LYXSERVER]
+ LYXERR(Debug::LYXSERVER)
<< "LyXServer: Client: '" << client
<< "' Command: '" << cmd
<< "' Argument: '" << arg << '\'' << endl;
if (cmd == "hello") {
// One more client
if (serv->numclients == MAX_CLIENTS) { //paranoid check
- lyxerr[Debug::LYXSERVER]
+ LYXERR(Debug::LYXSERVER)
<< "LyXServer: too many clients..."
<< endl;
return;
serv->clients[i] = client;
serv->numclients++;
buf = "LYXSRV:" + client + ":hello\n";
- lyxerr[Debug::LYXSERVER]
+ LYXERR(Debug::LYXSERVER)
<< "LyXServer: Greeting "
<< client << endl;
serv->pipes.send(buf);
if (i < serv->numclients) {
serv->numclients--;
serv->clients[i].erase();
- lyxerr[Debug::LYXSERVER]
+ LYXERR(Debug::LYXSERVER)
<< "LyXServer: Client "
<< client << " said goodbye"
<< endl;
} else {
- lyxerr[Debug::LYXSERVER]
+ LYXERR(Debug::LYXSERVER)
<< "LyXServer: ignoring bye messge from unregistered client"
<< client << endl;
}
} else {
lyxerr <<"LyXServer: Undefined server command "
- << cmd << "." << endl;
+ << cmd << '.' << endl;
}
return;
}
// support currently. (Lgb)
- serv->func->verboseDispatch(cmd + ' ' + arg, false);
- string const rval = serv->func->getMessage();
-
+ serv->func->dispatch(FuncRequest(lyxaction.lookupFunc(cmd), arg));
+ string const rval = to_utf8(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
buf = "ERROR:";
else
buf = "INFO:";
- buf += client + ":" + cmd + ":" + rval + "\n";
+ buf += client + ':' + cmd + ':' + rval + '\n';
serv->pipes.send(buf);
// !!! we don't do any error checking -
/* ---F+------------------------------------------------------------------ *\
- Function : LyxNotifyClient
+ Function : LyXNotifyClient
Called by : WorkAreaKeyPress
Purpose : send a notify messge to a client
Parameters: s - string to send
string buf = string("NOTIFY:") + s + "\n";
pipes.send(buf);
}
+
+
+} // namespace lyx