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