Clean up and fix, changed ssh exit stream command

* Cleaned up some old commented-out code
* Commented-out some `lock` and `unlock` calls because they were in the main thread
* Removed some global app variables that weren't really being used
* (Hopefully) fixed the remote desktop name of connected listening items (the desktop name would go away after a while)
* Changed the iffy ssh exit command to use escape characters CRLF + ~. + CRLF

Author: willbprog127

src/app.cxx

@@ -601,7 +601,6 @@ void svConfigWrite ()
     ofs << "vncpass=" << base64Encode(reinterpret_cast<const unsigned char *>
       (itm->vncPassword.c_str()), itm->vncPassword.size()) << std::endl;
     ofs << "type=" << itm->hostType << std::endl;
-    //ofs << "sshkeypublic=" << itm->sshKeyPublic << std::endl;
     ofs << "sshkeyprivate=" << itm->sshKeyPrivate << std::endl;
     ofs << "sshuser=" << itm->sshUser << std::endl;
     ofs << "sshpass=" << itm->sshPass << std::endl;
@@ -1911,43 +1910,33 @@ void svHandleMainWindowEvents (Fl_Widget * window, void *)
 void svPositionWidgets ()
 {
   // only continue if main window geometry changes
-  if (app->mainWin->w() != app->nMainWinPreviousW
-      || app->mainWin->h() != app->nMainWinPreviousH)
-  {
-    svDebugLog("svPositionWidgets - Resizing GUI elements");
-
-    // store window geometry for comparison later
-    app->nMainWinPreviousW = app->mainWin->w();
-    app->nMainWinPreviousH = app->mainWin->h();
-
-    // resize the host list vertically if the main window resizes
-    app->hostList->size(app->hostList->w(), app->mainWin->h() - 26);
+  svDebugLog("svPositionWidgets - Resizing GUI elements");
 
-    // set list buttons position
-    app->packButtons->position(3, app->hostList->x() + app->hostList->h() + 3);
+  // resize the host list vertically if the main window resizes
+  app->hostList->size(app->hostList->w(), app->mainWin->h() - 26);
 
-    // don't allow host list width to be smaller than right-most button's x+w
-    if (app->hostList->w() < (app->packButtons->x() + app->packButtons->w()))
-      app->hostList->size((app->packButtons->x() + app->packButtons->w()), app->hostList->h());
+  // set list buttons position
+  app->packButtons->position(3, app->hostList->x() + app->hostList->h() + 3);
 
-    // set scroller x
-    app->scroller->position(app->hostList->x() + app->hostList->w() + 3, app->scroller->y());
-    app->scroller->redraw();
+  // don't allow host list width to be smaller than right-most button's x+w
+  if (app->hostList->w() < (app->packButtons->x() + app->packButtons->w()))
+    app->hostList->size((app->packButtons->x() + app->packButtons->w()), app->hostList->h());
 
-    VncObject * vnc = app->vncViewer->vnc;
-
-    // reset scroller position
-    if (vnc != NULL)
-    {
-      svResizeScroller();
-      vnc->setObjectVisible();
-    }
+  // set scroller x
+  app->scroller->position(app->hostList->x() + app->hostList->w() + 3, app->scroller->y());
+  app->scroller->redraw();
 
-    Fl::redraw();
-    Fl::check();
+  VncObject * vnc = app->vncViewer->vnc;
 
-    return;
+  // reset scroller position
+  if (vnc != NULL)
+  {
+    svResizeScroller();
+    vnc->setObjectVisible();
   }
+
+  Fl::redraw();
+  Fl::check();
 }
 
 
@@ -1967,9 +1956,9 @@ void svHandleListItemIconChange (void *)
 
     if (itm != NULL && itm->icon != NULL)
     {
-      Fl::lock();
+      // Fl::lock();  // <<<--- commenting out because this is main thread ---<<<
       app->hostList->icon(i, itm->icon);
-      Fl::unlock();
+      // Fl::unlock();  // <<<--- commenting out because this is main thread ---<<<
       Fl::check();
     }
   }
@@ -1978,7 +1967,7 @@ void svHandleListItemIconChange (void *)
 }
 
 
-/* handle messages from child threads */
+/* handle connection changes from child threads */
 void svHandleThreadConnection (void * data)
 {
   HostItem * itm = static_cast<HostItem *>(data);
@@ -2026,8 +2015,9 @@ void svHandleThreadConnection (void * data)
 
       std::string strHostViewName = "Listening - ";
       strHostViewName.append(vnc->vncClient->desktopName);
+      itm->name = strHostViewName;
 
-      app->hostList->text(nListeningItem, strHostViewName.c_str());
+      app->hostList->text(nListeningItem, itm->name.c_str()); // strHostViewName.c_str());
 
       // (try to) create another listener
       svDebugLog("svConnectionWatcher - Creating Listener object");
@@ -2126,7 +2116,7 @@ void svHandleThreadCursorChange (void * setToDefault)
     if (vnc == NULL)
       return;
 
-    Fl::lock();
+    // Fl::lock();  // <<<--- commenting out because this is main thread ---<<<
 
     // set cursor, if valid
     if (vnc->imgCursor != NULL)
@@ -2136,7 +2126,7 @@ void svHandleThreadCursorChange (void * setToDefault)
     } else
       app->mainWin->cursor(FL_CURSOR_DEFAULT);
 
-    Fl::unlock();
+    // Fl::unlock();  // <<<--- commenting out because this is main thread ---<<<
 }
 
 
@@ -2149,17 +2139,16 @@ void svInsertEmptyItem ()
   itm->hostAddress = "192.168.0.1";
   itm->vncPort = "5900";
   itm->scaling = 'f';
-  // itm->sshKeyPublic = "";
   itm->sshKeyPrivate = "";
   itm->showRemoteCursor = true;
   itm->compressLevel = 5;
   itm->qualityLevel = 5;
 
-  Fl::lock();
+  // Fl::lock();  // <<<--- commenting out because this is main thread ---<<<
   app->hostList->add(itm->name.c_str(), itm);
   app->hostList->icon(app->hostList->size(), app->iconDisconnected);
   app->hostList->make_visible(app->hostList->size());
-  Fl::unlock();
+  // Fl::unlock();  // <<<--- commenting out because this is main thread ---<<<
 
   Fl::redraw();
   Fl::check();
@@ -2175,7 +2164,7 @@ int svItemNumFromItm (const HostItem * itmIn)
   HostItem * itm = NULL;
   uint16_t nSize = app->hostList->size();
 
-  Fl::lock();
+  // Fl::lock();  // <<<--- commenting out because this is main thread ---<<<
 
   // go through hostlist and find item owning matching itmIn
   for (uint16_t i = 0; i <= nSize; i ++)
@@ -2185,13 +2174,13 @@ int svItemNumFromItm (const HostItem * itmIn)
 
     if (itm != NULL && itm == itmIn)
     {
-      Fl::unlock();
+      // Fl::unlock();  // <<<--- commenting out because this is main thread ---<<<
 
       return i;
     }
   }
 
-  Fl::unlock();
+  // Fl::unlock();  // <<<--- commenting out because this is main thread ---<<<
 
   return 0;
 }
@@ -2206,7 +2195,7 @@ HostItem * svItmFromVnc (const VncObject * vncIn)
   HostItem * itm = NULL;
   uint16_t nSize = app->hostList->size();
 
-  Fl::lock();
+  // Fl::lock();  // <<<--- commenting out because this is main thread ---<<<
 
   for (uint16_t i = 0; i <= nSize; i ++)
   {
@@ -2217,14 +2206,14 @@ HostItem * svItmFromVnc (const VncObject * vncIn)
       {
         if (itm->vnc == vncIn)
         {
-          Fl::unlock();
+          // Fl::unlock();  // <<<--- commenting out because this is main thread ---<<<
 
           return itm;
         }
       }
   }
 
-  Fl::unlock();
+  // Fl::unlock();  // <<<--- commenting out because this is main thread ---<<<
 
   return NULL;
 }
@@ -2928,7 +2917,6 @@ void svShowItemOptions (HostItem * im)
     itm->vncPort = "5900";
     itm->sshPort = "";
     itm->scaling = 's';
-    // itm->sshKeyPublic = "";
     itm->sshKeyPrivate = "";
     itm->showRemoteCursor = true;
     itm->compressLevel = 5;

src/app.h

@@ -113,8 +113,6 @@ class AppVars
     itmBeingEdited(NULL),
     scanIsRunning(false),
     nCurrentScanItem(0),
-    nMainWinPreviousW(0),
-    nMainWinPreviousH(0),
     nScanTimeout(2),
     nDeadTimeout(100),
     nStartingLocalPort(15000),
@@ -152,12 +150,12 @@ class AppVars
       std::cout << "SpiritVNC - FLTK: CRITICAL - Could not get user's login name"
           " from environment\n\nExiting\n";
 
-      Fl::lock();
+      // Fl::lock();  // <<<--- commenting out because this is main thread ---<<<
       fl_message_hotspot(0);
       fl_message_title("SpiritVNC - FLTK");
       fl_message("%s", "CRITICAL ERROR - Could not get user's login name"
           " from environment\n\nExiting\n");
-      Fl::unlock();
+      // Fl::unlock();  // <<<--- commenting out because this is main thread ---<<<
       exit(1);
     }
 
@@ -210,8 +208,6 @@ class AppVars
   HostItem * itmBeingEdited;
   bool scanIsRunning;
   int nCurrentScanItem;
-  int nMainWinPreviousW;
-  int nMainWinPreviousH;
   int nScanTimeout;
   int nDeadTimeout;
   int nStartingLocalPort;
@@ -281,7 +277,7 @@ void svHandleHostListButtons (Fl_Widget *, void *);
 void svHandleHostListEvents (Fl_Widget *, void *);
 void svHandleMainWindowEvents (Fl_Widget *, void *);
 void svPositionWidgets ();
-void svHandleListItemIconChange (void * notUsed);
+void svHandleListItemIconChange (void *);
 void svHandleThreadConnection (void *);
 void svHandleThreadCursorChange (void *);
 void svInsertEmptyItem ();

src/hostitem.h

@@ -55,16 +55,13 @@ class HostItem
     sshPort(""),
     sshUser(""),
     sshPass(""),
-    // sshKeyPublic(""),
     sshKeyPrivate(""),
     sshLocalPort(0),
     vncPassword(""),
     hostType('v'),
     vnc(NULL),
     threadRFB(0),
     threadRFBRunning(false),
-    //threadSSH(0),
-    //threadLoop(0),
     sshReady(false),
     vncAddressAndPort(""),
     f12Macro(""),
@@ -98,16 +95,13 @@ class HostItem
   std::string sshPort;
   std::string sshUser;
   std::string sshPass;
-  // std::string sshKeyPublic;
   std::string sshKeyPrivate;
   int sshLocalPort;
   std::string vncPassword;
   char hostType;
   VncObject * vnc;
   pthread_t threadRFB;
   bool threadRFBRunning;
-  //pthread_t threadSSH;
-  //pthread_t threadLoop;
   bool sshReady;
   std::string vncAddressAndPort;
   std::string f12Macro;

src/ssh.cxx

@@ -37,6 +37,7 @@
 
 
 /* attempts to close the popen'd ssh process */
+/* (run as thread) */
 void * svSSHCloseHelper (void * itmData)
 {
   // detach this thread
@@ -47,9 +48,15 @@ void * svSSHCloseHelper (void * itmData)
   if (itm == NULL || itm->sshCmdStream == NULL)
     return SV_RET_VOID;
 
-  fprintf(itm->sshCmdStream, "%s\r\n", "exit");
+  // fprintf(itm->sshCmdStream, "%s\r\n", "exit");  //  <<--- trying different way to close (below) ---<<<
+
+  // send 'exit' control-char sequence
+  fprintf(itm->sshCmdStream, "\r\n%s", "~.");
   fflush(itm->sshCmdStream);
+  // send extra CRLF, just for fun
+  fprintf(itm->sshCmdStream, "\r\n");
 
+  // close the ssh process command stream
   pclose(itm->sshCmdStream);
 
   return SV_RET_VOID;

src/vnc.cxx

@@ -184,28 +184,8 @@ void VncObject::createVNCObject (HostItem * itm)
       svDebugLog("svCreateVNCObject - Creating and running threadSSH");
 
       // create, launch and detach call to create our ssh connection
-      //int sshResult = pthread_create(&itm->threadSSH, NULL, svCreateSSHConnection, itm);
       svCreateSSHConnection(itm);
 
-      ////if (sshResult != 0)
-      //// ### THIS BLOCK COMMENTED OUT 2022-08-05 ###
-      //if (itm->sshReady == false)
-      //{
-        //svLogToFile("ERROR - Couldn't create SSH thread for '" + itm->name +
-          //"' - " + itm->hostAddress);
-        //itm->isConnecting = false;
-        //itm->hasCouldntConnect = true;
-        //itm->hasError = true;
-        //itm->lastErrorMessage = "Unable to make SSH connection";
-
-        ////if (vnc != NULL && vnc->vncClient != NULL)
-        //VncObject::endAndDeleteViewer(&vnc);
-
-        //svHandleThreadConnection(itm);
-
-        //return;
-      //}
-
       time_t sshDelay = time(NULL) + itm->sshWaitTime;
 
       svDebugLog("svCreateVNCObject - About to enter itm->sshReady timer loop");
@@ -722,9 +702,9 @@ void VncObject::masterMessageLoop ()
       // for (uint16_t i = 0; i <= app->hostList->size(); i ++)
       for (uint16_t i = 0; i <= nSize; i ++)
       {
-        Fl::lock();
+        // Fl::lock();  // <<<--- commenting out because this is main thread ---<<<
         itm = static_cast<HostItem *>(app->hostList->data(i));
-        Fl::unlock();
+        // Fl::unlock();  // <<<--- commenting out because this is main thread ---<<<
 
         if (itm == NULL)
           continue;