src/lyxserver.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Processor
   5  *
   6  *           Copyright 1995 Matthias Ettrich
   7  *           Copyright 1995-2001 The LyX Team.
   8  *
   9  * ====================================================== */
  10
  11 /**
  12   Docu   : To use the lyxserver define the name of the pipe in your
  13            lyxrc:
  14            \serverpipe "/home/myhome/.lyxpipe"
  15            Then use .lyxpipe.in and .lyxpipe.out to communicate to LyX.
  16            Each message consists of a single line in ASCII. Input lines
  17            (client -> LyX) have the following format:
  18             "LYXCMD:<clientname>:<functionname>:<argument>"
  19            Answers from LyX look like this:
  20            "INFO:<clientname>:<functionname>:<data>"
  21  [asierra970531] Or like this in case of error:
  22            "ERROR:<clientname>:<functionname>:<error message>"
  23            where <clientname> and <functionname> are just echoed.
  24            If LyX notifies about a user defined extension key-sequence,
  25            the line looks like this:
  26            "NOTIFY:<key-sequence>"
  27  [asierra970531] New server-only messages to implement a simple protocol
  28            "LYXSRV:<clientname>:<protocol message>"
  29            where <protocol message> can be "hello" or "bye". If hello is
  30            received LyX will inform the client that it's listening its
  31            messages, and 'bye' will inform that lyx is closing.
  32
  33            See development/server_monitor.c for an example client.
  34   Purpose: implement a client/server lib for LyX
  35 */
  36
  37 #include <config.h>
  38
  39 #include <sys/types.h>
  40 #include <sys/stat.h>
  41 #include <unistd.h>
  42 #include <fcntl.h>
  43 #include <cerrno>
  44 #include FORMS_H_LOCATION
  45
  46 #ifdef __GNUG__
  47 #pragma implementation
  48 #endif
  49
  50 #include "lyxserver.h"
  51 #include "lyx_main.h"
  52 #include "debug.h"
  53 #include "lyxfunc.h"
  54 #include "support/lstrings.h"
  55 #include "support/lyxlib.h"
  56 #include "frontends/lyx_gui.h"
  57
  58 #ifdef __EMX__
  59 #include <cstdlib>
  60 #include <io.h>
  61 #define OS2EMX_PLAIN_CHAR
  62 #define INCL_DOSNMPIPES
  63 #define INCL_DOSERRORS
  64 #include <os2.h>
  65 #include "support/os2_errortable.h"
  66 #endif
  67
  68 using std::endl;
  69
  70 // provide an empty mkfifo() if we do not have one. This disables the
  71 // lyxserver.
  72 #ifndef HAVE_MKFIFO
  73 int mkfifo(char const * __path, mode_t __mode) {
  74         return 0;
  75 }
  76 #endif
  77
  78
  79 void LyXComm::openConnection()
  80 {
  81         lyxerr[Debug::LYXSERVER] << "LyXComm: Opening connection" << endl;
  82
  83         // If we are up, that's an error
  84         if (ready) {
  85                 lyxerr << "LyXComm: Already connected" << endl;
  86                 return;
  87         }
  88         // We assume that we don't make it
  89         ready = false;
  90
  91         if (pipename.empty()) {
  92                 lyxerr[Debug::LYXSERVER]
  93                         << "LyXComm: server is disabled, nothing to do"
  94                         << endl;
  95                 return;
  96         }
  97
  98         if ((infd = startPipe(inPipeName(), false)) == -1)
  99                 return;
 100
 101         if ((outfd = startPipe(outPipeName(), true)) == -1) {
 102                 endPipe(infd, inPipeName(), false);
 103                 return;
 104         }
 105
 106         if (fcntl(outfd, F_SETFL, O_NONBLOCK) < 0) {
 107                 lyxerr << "LyXComm: Could not set flags on pipe " << outPipeName()
 108                        << '\n' << strerror(errno) << endl;
 109                 return;
 110         }
 111
 112         // We made it!
 113         ready = true;
 114         lyxerr[Debug::LYXSERVER] << "LyXComm: Connection established" << endl;
 115 }
 116
 117
 118 /// Close pipes
 119 void LyXComm::closeConnection()
 120 {
 121         lyxerr[Debug::LYXSERVER] << "LyXComm: Closing connection" << endl;
 122
 123         if (pipename.empty()) {
 124                 lyxerr[Debug::LYXSERVER]
 125                         << "LyXComm: server is disabled, nothing to do"
 126                         << endl;
 127                 return;
 128         }
 129
 130         if (!ready) {
 131                 lyxerr << "LyXComm: Already disconnected" << endl;
 132                 return;
 133         }
 134
 135         endPipe(infd, inPipeName(), false);
 136         endPipe(outfd, outPipeName(), true);
 137
 138         ready = false;
 139 }
 140
 141 int LyXComm::startPipe(string const & filename, bool write)
 142 {
 143         int fd;
 144
 145 #ifdef __EMX__
 146         HPIPE os2fd;
 147         APIRET rc;
 148         int errnum;
 149         // Try create one instance of named pipe with the mode O_RDONLY|O_NONBLOCK.
 150         // The current emx implementation of access() won't work with pipes.
 151         rc = DosCreateNPipe(filename.c_str(), &os2fd, NP_ACCESS_INBOUND,
 152                 NP_NOWAIT|0x01, 0600, 0600, 0);
 153         if (rc == ERROR_PIPE_BUSY) {
 154                 lyxerr << "LyXComm: Pipe " << filename << " already exists.\n"
 155                        << "If no other LyX program is active, please delete"
 156                         " the pipe by hand and try again." << endl;
 157                 pipename.erase();
 158                 return -1;
 159         }
 160
 161         if (rc != NO_ERROR) {
 162                 errnum = TranslateOS2Error(rc);
 163                 lyxerr <<"LyXComm: Could not create pipe " << filename
 164                        << strerror(errnum) << endl;
 165                 return -1;
 166         };
 167         // Listen to it.
 168         rc = DosConnectNPipe(os2fd);
 169         if (rc != NO_ERROR && rc != ERROR_PIPE_NOT_CONNECTED) {
 170                 errnum = TranslateOS2Error(rc);
 171                 lyxerr <<"LyXComm: Could not create pipe " << filename
 172                        << strerror(errnum) << endl;
 173                 return -1;
 174         };
 175         // Imported handles can be used both with OS/2 APIs and emx
 176         // library functions.
 177         fd = _imphandle(os2fd);
 178 #else
 179         if (::access(filename.c_str(), F_OK) == 0) {
 180                 lyxerr << "LyXComm: Pipe " << filename << " already exists.\n"
 181                        << "If no other LyX program is active, please delete"
 182                         " the pipe by hand and try again." << endl;
 183                 pipename.erase();
 184                 return -1;
 185         }
 186
 187         if (::mkfifo(filename.c_str(), 0600) < 0) {
 188                 lyxerr << "LyXComm: Could not create pipe " << filename << '\n'
 189                        << strerror(errno) << endl;
 190                 return -1;
 191         };
 192         fd = ::open(filename.c_str(), write ? (O_RDWR) : (O_RDONLY|O_NONBLOCK));
 193 #endif
 194
 195         if (fd < 0) {
 196                 lyxerr << "LyXComm: Could not open pipe " << filename << '\n'
 197                        << strerror(errno) << endl;
 198                 lyx::unlink(filename);
 199                 return -1;
 200         }
 201
 202         if (!write) {
 203                 lyx_gui::set_read_callback(fd, this);
 204         }
 205
 206         return fd;
 207 }
 208
 209
 210 void LyXComm::endPipe(int & fd, string const & filename, bool write)
 211 {
 212         if (fd < 0)
 213                 return;
 214
 215         if (!write) {
 216                 lyx_gui::remove_read_callback(fd);
 217         }
 218
 219 #ifdef __EMX__
 220         APIRET rc;
 221         int errnum;
 222
 223         rc = DosDisConnectNPipe(fd);
 224         if (rc != NO_ERROR) {
 225                 errnum = TranslateOS2Error(rc);
 226                 lyxerr << "LyXComm: Could not disconnect pipe " << filename
 227                        << '\n' << strerror(errnum) << endl;
 228                 return;
 229         }
 230 #endif
 231
 232         if (::close(fd) < 0) {
 233                 lyxerr << "LyXComm: Could not close pipe " << filename
 234                        << '\n' << strerror(errno) << endl;
 235         }
 236
 237 // OS/2 pipes are deleted automatically
 238 #ifndef __EMX__
 239         if (lyx::unlink(filename) < 0) {
 240                 lyxerr << "LyXComm: Could not remove pipe " << filename
 241                        << '\n' << strerror(errno) << endl;
 242         };
 243 #endif
 244
 245         fd = -1;
 246 }
 247
 248
 249 void LyXComm::emergencyCleanup()
 250 {
 251         if (!pipename.empty()) {
 252                 endPipe(infd, inPipeName(), false);
 253                 endPipe(outfd, outPipeName(), true);
 254         }
 255 }
 256
 257
 258 // Receives messages and sends then to client
 259 void LyXComm::read_ready()
 260 {
 261         if (lyxerr.debugging(Debug::LYXSERVER)) {
 262                 lyxerr << "LyXComm: Receiving from fd " << infd << endl;
 263         }
 264
 265         int const CMDBUFLEN = 100;
 266         char charbuf[CMDBUFLEN];
 267         string cmd;
 268 // nb! make lsbuf a class-member for multiple sessions
 269         static string lsbuf;
 270
 271         errno = 0;
 272         int status;
 273         // the single = is intended here.
 274         while ((status = read(infd, charbuf, CMDBUFLEN-1))) {
 275                 if (status > 0) {
 276                         charbuf[status]= '\0'; // turn it into a c string
 277                         lsbuf += rtrim(charbuf, "\r");
 278                         // commit any commands read
 279                         while (lsbuf.find('\n') != string::npos) {
 280                                 // split() grabs the entire string if
 281                                 // the delim /wasn't/ found. ?:-P
 282                                 lsbuf= split(lsbuf, cmd,'\n');
 283                                 lyxerr[Debug::LYXSERVER]
 284                                         << "LyXComm: status:" << status
 285                                         << ", lsbuf:" << lsbuf
 286                                         << ", cmd:" << cmd << endl;
 287                                 if (!cmd.empty())
 288                                         clientcb(client, cmd);
 289                                         //\n or not \n?
 290                         }
 291                 }
 292                 if (errno == EAGAIN) {
 293                         errno = 0;
 294                         return;
 295                 }
 296                 if (errno != 0) {
 297                         lyxerr << "LyXComm: " << strerror(errno) << endl;
 298                         if (!lsbuf.empty())
 299                         {
 300                                 lyxerr << "LyxComm: truncated command: "
 301                                        << lsbuf << endl;
 302                                 lsbuf.erase();
 303                         }
 304                         break; // reset connection
 305                 }
 306         }
 307         closeConnection();
 308         openConnection();
 309         errno= 0;
 310 }
 311
 312
 313 void LyXComm::send(string const & msg)
 314 {
 315         if (msg.empty()) {
 316                 lyxerr << "LyXComm: Request to send empty string. Ignoring."
 317                        << endl;
 318                 return;
 319         }
 320
 321         if (lyxerr.debugging(Debug::LYXSERVER)) {
 322                 lyxerr << "LyXComm: Sending '" << msg << '\'' << endl;
 323         }
 324
 325         if (pipename.empty()) return;
 326
 327         if (!ready) {
 328                 lyxerr << "LyXComm: Pipes are closed. Could not send "
 329                        << msg << endl;
 330         } else if (::write(outfd, msg.c_str(), msg.length()) < 0) {
 331                 lyxerr << "LyXComm: Error sending message: " << msg
 332                        << '\n' << strerror(errno)
 333                        << "\nLyXComm: Resetting connection" << endl;
 334                 closeConnection();
 335                 openConnection();
 336         }
 337 #ifdef __EMX__
 338         APIRET rc;
 339         int errnum;
 340         rc = DosResetBuffer(outfd);     // To avoid synchronization problems.
 341         if (rc != NO_ERROR) {
 342                 errnum = TranslateOS2Error(rc);
 343                 lyxerr << "LyXComm: Message could not be flushed: " << msg
 344                        << '\n' << strerror(errnum) << endl;
 345         }
 346 #endif
 347 }
 348
 349
 350 // LyXServer class
 351
 352 LyXServer::~LyXServer()
 353 {
 354         // say goodbye to clients so they stop sending messages
 355         // modified june 1999 by stefano@zool.su.se to send as many bye
 356         // messages as there are clients, each with client's name.
 357         string message;
 358         for (int i= 0; i<numclients; ++i) {
 359                 message = "LYXSRV:" + clients[i] + ":bye\n";
 360                 pipes.send(message);
 361         }
 362 }
 363
 364
 365 /* ---F+------------------------------------------------------------------ *\
 366    Function  : ServerCallback
 367     Called by : LyXComm
 368     Purpose   : handle data gotten from communication
 369 \* ---F------------------------------------------------------------------- */
 370
 371 void LyXServer::callback(LyXServer * serv, string const & msg)
 372 {
 373         lyxerr[Debug::LYXSERVER] << "LyXServer: Received: '"
 374                                  << msg << '\'' << endl;
 375
 376         char const * p = msg.c_str();
 377
 378         // --- parse the string --------------------------------------------
 379         //
 380         //  Format: LYXCMD:<client>:<func>:<argstring>\n
 381         //
 382         bool server_only = false;
 383         while (*p) {
 384                 // --- 1. check 'header' ---
 385
 386                 if (compare(p, "LYXSRV:", 7) == 0) {
 387                         server_only = true;
 388                 } else if (0 != compare(p, "LYXCMD:", 7)) {
 389                         lyxerr << "LyXServer: Unknown request \"" << p << "\"" << endl;
 390                         return;
 391                 }
 392                 p += 7;
 393
 394                 // --- 2. for the moment ignore the client name ---
 395                 string client;
 396                 while (*p && *p != ':')
 397                         client += char(*p++);
 398                 if (*p == ':') ++p;
 399                 if (!*p) return;
 400
 401                 // --- 3. get function name ---
 402                 string cmd;
 403                 while (*p && *p != ':')
 404                         cmd += char(*p++);
 405
 406                 // --- 4. parse the argument ---
 407                 string arg;
 408                 if (!server_only && *p == ':' && *(++p)) {
 409                         while (*p && *p != '\n')
 410                                 arg += char(*p++);
 411                         if (*p) ++p;
 412                 }
 413
 414                 lyxerr[Debug::LYXSERVER]
 415                         << "LyXServer: Client: '" << client
 416                         << "' Command: '" << cmd
 417                         << "' Argument: '" << arg << '\'' << endl;
 418
 419                 // --- lookup and exec the command ------------------
 420
 421                 if (server_only) {
 422                         string buf;
 423                         // return the greeting to inform the client that
 424                         // we are listening.
 425                         if (cmd == "hello") {
 426                                 // One more client
 427                                 if (serv->numclients == MAX_CLIENTS) { //paranoid check
 428                                         lyxerr[Debug::LYXSERVER]
 429                                                 << "LyXServer: too many clients..."
 430                                                 << endl;
 431                                         return;
 432                                 }
 433                                 int i= 0; //find place in clients[]
 434                                 while (!serv->clients[i].empty()
 435                                        && i<serv->numclients)
 436                                         ++i;
 437                                 serv->clients[i] = client;
 438                                 serv->numclients++;
 439                                 buf = "LYXSRV:" + client + ":hello\n";
 440                                 lyxerr[Debug::LYXSERVER]
 441                                         << "LyXServer: Greeting "
 442                                         << client << endl;
 443                                 serv->pipes.send(buf);
 444                         } else if (cmd == "bye") {
 445                                 // If clients == 0 maybe we should reset the pipes
 446                                 // to prevent fake callbacks
 447                                 int i = 0; //look if client is registered
 448                                 for (; i < serv->numclients; ++i) {
 449                                         if (serv->clients[i] == client) break;
 450                                 }
 451                                 if (i < serv->numclients) {
 452                                         serv->numclients--;
 453                                         serv->clients[i].erase();
 454                                         lyxerr[Debug::LYXSERVER]
 455                                                 << "LyXServer: Client "
 456                                                 << client << " said goodbye"
 457                                                 << endl;
 458                                 } else {
 459                                         lyxerr[Debug::LYXSERVER]
 460                                                 << "LyXServer: ignoring bye messge from unregistered client"
 461                                                 << client << endl;
 462                                 }
 463                         } else {
 464                                 lyxerr <<"LyXServer: Undefined server command "
 465                                        << cmd << "." << endl;
 466                         }
 467                         return;
 468                 }
 469
 470                 if (!cmd.empty()) {
 471                         // which lyxfunc should we let it connect to?
 472                         // The correct solution would be to have a
 473                         // specialized (non-gui) BufferView. But how do
 474                         // we do it now? Probably we should just let it
 475                         // connect to the lyxfunc in the single LyXView we
 476                         // support currently. (Lgb)
 477
 478
 479                         serv->func->dispatch(cmd + ' ' + arg);
 480                         string const rval = serv->func->getMessage();
 481
 482                         //modified june 1999 stefano@zool.su.se:
 483                         //all commands produce an INFO or ERROR message
 484                         //in the output pipe, even if they do not return
 485                         //anything. See chapter 4 of Customization doc.
 486                         string buf;
 487                         if (serv->func->errorStat())
 488                                 buf = "ERROR:";
 489                         else
 490                                 buf = "INFO:";
 491                         buf += client + ":" + cmd + ":" +  rval + "\n";
 492                         serv->pipes.send(buf);
 493
 494                         // !!! we don't do any error checking -
 495                         //  if the client won't listen, the
 496                         //  message is lost and others too
 497                         //  maybe; so the client should empty
 498                         //  the outpipe before issuing a request.
 499
 500                         // not found
 501                 }
 502         }  /* while *p */
 503 }
 504
 505
 506 /* ---F+------------------------------------------------------------------ *\
 507    Function  : LyxNotifyClient
 508    Called by : WorkAreaKeyPress
 509    Purpose   : send a notify messge to a client
 510    Parameters: s - string to send
 511    Returns   : nothing
 512    \* ---F------------------------------------------------------------------- */
 513
 514 void LyXServer::notifyClient(string const & s)
 515 {
 516         string buf = string("NOTIFY:") + s + "\n";
 517         pipes.send(buf);
 518 }