src/gtk/utilsgtk.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        utils.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
   7 // Licence:           wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 //#ifdef __GNUG__
  12 //#pragma implementation "utils.h"
  13 //#endif
  14
  15 #include "wx/utils.h"
  16 #include "wx/string.h"
  17
  18 #include "wx/intl.h"
  19 #include "wx/log.h"
  20
  21 #include "wx/process.h"
  22
  23 #include <stdarg.h>
  24 #include <dirent.h>
  25 #include <string.h>
  26 #include <sys/stat.h>
  27 #include <sys/types.h>
  28 #include <unistd.h>
  29 #include <sys/wait.h>
  30 #include <pwd.h>
  31 #include <errno.h>
  32 #include <netdb.h>
  33 #include <signal.h>
  34 #include <fcntl.h>          // for O_WRONLY and friends
  35
  36 #include "glib.h"
  37 #include "gdk/gdk.h"
  38 #include "gtk/gtk.h"
  39 #include "gtk/gtkfeatures.h"
  40 #include "gdk/gdkx.h"
  41
  42 #ifdef __SVR4__
  43   #include <sys/systeminfo.h>
  44 #endif
  45
  46 #ifdef __SOLARIS__
  47 // somehow missing from sys/wait.h but in the system's docs
  48 extern "C"
  49 {
  50    pid_t wait4(pid_t pid, int *statusp, int options, struct rusage
  51                *rusage);
  52 }
  53 #endif
  54
  55 //------------------------------------------------------------------------
  56 // misc.
  57 //------------------------------------------------------------------------
  58
  59 void wxBell(void)
  60 {
  61     gdk_beep();
  62 }
  63
  64 void wxSleep(int nSecs)
  65 {
  66     sleep(nSecs);
  67 }
  68
  69 int wxKill(long pid, int sig)
  70 {
  71     return kill(pid, sig);
  72 }
  73
  74 void wxDisplaySize( int *width, int *height )
  75 {
  76     if (width) *width = gdk_screen_width();
  77     if (height) *height = gdk_screen_height();
  78 }
  79
  80 void wxGetMousePosition( int* x, int* y )
  81 {
  82     gdk_window_get_pointer( (GdkWindow*) NULL, x, y, (GdkModifierType*) NULL );
  83 }
  84
  85 bool wxColourDisplay(void)
  86 {
  87     return TRUE;
  88 }
  89
  90 int wxDisplayDepth(void)
  91 {
  92     return gdk_window_get_visual( (GdkWindow*) &gdk_root_parent )->depth;
  93 }
  94
  95 int wxGetOsVersion(int *majorVsn, int *minorVsn)
  96 {
  97   if (majorVsn) *majorVsn = GTK_MAJOR_VERSION;
  98   if (minorVsn) *minorVsn = GTK_MINOR_VERSION;
  99
 100   return wxGTK;
 101 }
 102
 103 //------------------------------------------------------------------------
 104 // user and home routines
 105 //------------------------------------------------------------------------
 106
 107 const char* wxGetHomeDir( wxString *home  )
 108 {
 109     *home = wxGetUserHome( wxString() );
 110     if (home->IsNull()) *home = "/";
 111     return *home;
 112 }
 113
 114 char *wxGetUserHome( const wxString &user )
 115 {
 116     struct passwd *who = (struct passwd *) NULL;
 117
 118     if (user.IsNull() || (user== ""))
 119     {
 120         register char *ptr;
 121
 122         if ((ptr = getenv("HOME")) != NULL)
 123         {
 124             return ptr;
 125         }
 126         if ((ptr = getenv("USER")) != NULL || (ptr = getenv("LOGNAME")) != NULL)
 127         {
 128             who = getpwnam(ptr);
 129         }
 130
 131         /* We now make sure the the user exists! */
 132         if (who == NULL)
 133         {
 134             who = getpwuid(getuid());
 135         }
 136     }
 137     else
 138     {
 139       who = getpwnam (user);
 140     }
 141
 142     return who ? who->pw_dir : (char*)NULL;
 143 }
 144
 145 //------------------------------------------------------------------------
 146 // id routines
 147 //------------------------------------------------------------------------
 148
 149 bool wxGetHostName(char *buf, int sz)
 150 {
 151     *buf = '\0';
 152 #if defined(__SVR4__) && !defined(__sgi)
 153     //KB: does this return the fully qualified host.domain name?
 154     return (sysinfo(SI_HOSTNAME, buf, sz) != -1);
 155 #else /* BSD Sockets */
 156     char name[255], domain[255];
 157     //struct hostent *h;
 158     // Get hostname
 159     if (gethostname(name, sizeof(name)/sizeof(char)-1) == -1)
 160         return FALSE;
 161     if (getdomainname(domain, sizeof(domain)/sizeof(char)-1) == -1)
 162         return FALSE;
 163     // Get official full name of host
 164     // doesn't return the full qualified name, replaced by following
 165     // code (KB)
 166     // strncpy(buf, (h=gethostbyname(name))!=NULL ? h->h_name : name, sz-1);
 167     if((unsigned)sz > strlen(name)+strlen(domain)+1)
 168     {
 169         strcpy(buf, name);
 170         if(strcmp(domain,"(none)") == 0) // standalone machine
 171         {
 172             strcat(buf,".");
 173             strcat(buf,domain);
 174         }
 175     }
 176     else
 177         return FALSE;
 178     return TRUE;
 179 #endif
 180 }
 181
 182 bool wxGetUserId(char *buf, int sz)
 183 {
 184     struct passwd *who;
 185
 186     *buf = '\0';
 187     if ((who = getpwuid(getuid ())) != NULL) {
 188         strncpy (buf, who->pw_name, sz-1);
 189         return TRUE;
 190     }
 191     return FALSE;
 192 }
 193
 194 bool wxGetUserName(char *buf, int sz)
 195 {
 196     struct passwd *who;
 197     char *comma;
 198
 199     *buf = '\0';
 200     if ((who = getpwuid (getuid ())) != NULL) {
 201        comma = strchr(who->pw_gecos,'c');
 202        if(comma) *comma = '\0'; // cut off non-name comment fields
 203        strncpy (buf, who->pw_gecos, sz - 1);
 204         return TRUE;
 205     }
 206     return FALSE;
 207 }
 208
 209 //------------------------------------------------------------------------
 210 // error and debug output routines
 211 //------------------------------------------------------------------------
 212
 213 void wxDebugMsg( const char *format, ... )
 214 {
 215   va_list ap;
 216   va_start( ap, format );
 217   vfprintf( stderr, format, ap );
 218   fflush( stderr );
 219   va_end(ap);
 220 }
 221
 222 void wxError( const wxString &msg, const wxString &title )
 223 {
 224   fprintf( stderr, "Error " );
 225   if (!title.IsNull()) fprintf( stderr, "%s ", WXSTRINGCAST(title) );
 226   if (!msg.IsNull()) fprintf( stderr, ": %s", WXSTRINGCAST(msg) );
 227   fprintf( stderr, ".\n" );
 228 }
 229
 230 void wxFatalError( const wxString &msg, const wxString &title )
 231 {
 232   fprintf( stderr, "Error " );
 233   if (!title.IsNull()) fprintf( stderr, "%s ", WXSTRINGCAST(title) );
 234   if (!msg.IsNull()) fprintf( stderr, ": %s", WXSTRINGCAST(msg) );
 235   fprintf( stderr, ".\n" );
 236   exit(3); // the same exit code as for abort()
 237 }
 238
 239 //------------------------------------------------------------------------
 240 // directory routines
 241 //------------------------------------------------------------------------
 242
 243 bool wxDirExists( const wxString& dir )
 244 {
 245     char buf[500];
 246     strcpy( buf, WXSTRINGCAST(dir) );
 247     struct stat sbuf;
 248     return ((stat(buf, &sbuf) != -1) && S_ISDIR(sbuf.st_mode) ? TRUE : FALSE);
 249 }
 250
 251 //------------------------------------------------------------------------
 252 // subprocess routines
 253 //------------------------------------------------------------------------
 254
 255 // if pid > 0, the execution is async and the data is freed in
 256 // GTK_EndProcessDetector, if pid < 0, the execution is synchronous and the
 257 // caller (wxExecute) frees the data
 258 struct wxEndProcessData
 259 {
 260     gint pid, tag;
 261     wxProcess *process;
 262     int  exitcode;
 263 };
 264
 265 static void GTK_EndProcessDetector(gpointer data, gint source,
 266                                    GdkInputCondition WXUNUSED(condition) )
 267 {
 268     wxEndProcessData *proc_data = (wxEndProcessData *)data;
 269     int pid;
 270
 271     pid = (proc_data->pid > 0) ? proc_data->pid : -(proc_data->pid);
 272
 273     /* wait4 is not part of any standard, use at own risk
 274      * not sure what wait4 does, but wait3 seems to be closest, whats a digit ;-)
 275      * --- offer@sgi.com */
 276     // VZ: wait4() will be woken up by a signal, not wait3 - so it's quite
 277     //     different (also, wait3() waits for any child, wait4() only for this
 278     //     one)
 279     int status = -1;
 280 #if !defined(__sgi)
 281     wait4(pid, &status, 0, (rusage *) NULL);
 282 #else
 283     wait3(&status, 0, (rusage *) NULL);
 284 #endif
 285
 286     close(source);
 287     gdk_input_remove(proc_data->tag);
 288
 289     if (proc_data->process)
 290         proc_data->process->OnTerminate(proc_data->pid, status);
 291
 292     if (proc_data->pid > 0)
 293     {
 294         delete proc_data;
 295     }
 296     else
 297     {
 298         // wxExecute() will know about it
 299         proc_data->exitcode = status;
 300
 301         proc_data->pid = 0;
 302     }
 303 }
 304
 305 long wxExecute( char **argv, bool sync, wxProcess *process )
 306 {
 307     wxEndProcessData *data = new wxEndProcessData;
 308     int end_proc_detect[2];
 309
 310     wxCHECK_MSG( *argv, 0, "can't exec empty command" );
 311
 312     /* Create pipes */
 313     if (pipe(end_proc_detect) == -1)
 314     {
 315         wxLogSysError( _("Pipe creation failed") );
 316         return 0;
 317     }
 318
 319     /* fork the process */
 320 #if defined(sun) || defined(__ultrix) || defined(__bsdi__)
 321     pid_t pid = vfork();
 322 #else
 323     pid_t pid = fork();
 324 #endif
 325     if (pid == -1)
 326     {
 327         wxLogSysError( _("Fork failed") );
 328         return 0;
 329     }
 330     else if (pid == 0)
 331     {
 332         // we're in child
 333         close(end_proc_detect[0]); // close reading side
 334
 335         // These three lines close the open file descriptors to to avoid any
 336         // input/output which might block the process or irritate the user. If
 337         // one wants proper IO for the subprocess, the "right thing to do is
 338         // to start an xterm executing it.
 339         close(STDIN_FILENO);
 340         close(STDOUT_FILENO);
 341
 342         // leave stderr opened, it won't do any hurm
 343 #if 0
 344         close(STDERR_FILENO);
 345
 346         // some programs complain about stderr not being open, so redirect
 347         // them:
 348         open("/dev/null", O_RDONLY);  // stdin
 349         open("/dev/null", O_WRONLY);  // stdout
 350         open("/dev/null", O_WRONLY);  // stderr
 351 #endif
 352
 353 #ifdef _AIX
 354         execvp ((const char *)*argv, (const char **)argv);
 355 #else
 356         execvp (*argv, argv);
 357 #endif
 358
 359         // there is no return after successful exec()
 360         fprintf(stderr, _("Can't execute '%s'\n"), *argv);
 361
 362         _exit(-1);
 363     }
 364     else
 365     {
 366         // we're in parent
 367         close(end_proc_detect[1]); // close writing side
 368         data->tag = gdk_input_add(end_proc_detect[0], GDK_INPUT_READ,
 369                                   GTK_EndProcessDetector, (gpointer)data);
 370         if ( sync )
 371         {
 372             wxASSERT_MSG( !process, "wxProcess param ignored for sync exec" );
 373             data->process = NULL;
 374
 375             // sync execution: indicate it by negating the pid
 376             data->pid = -pid;
 377
 378             // it will be set to 0 from GTK_EndProcessDetector
 379             while (data->pid != 0)
 380                 wxYield();
 381
 382             int exitcode = data->exitcode;
 383
 384             delete data;
 385
 386             return exitcode;
 387         }
 388         else
 389         {
 390             // async execution, nothing special to do - caller will be
 391             // notified about the process terminationif process != NULL, data
 392             // will be deleted in GTK_EndProcessDetector
 393             data->process = process;
 394             data->pid = pid;
 395
 396             return pid;
 397         }
 398     }
 399 }
 400
 401 long wxExecute( const wxString& command, bool sync, wxProcess *process )
 402 {
 403     static const char *IFS = " \t\n";
 404
 405     wxCHECK_MSG( !command.IsEmpty(), 0, "can't exec empty command" );
 406
 407     int argc = 0;
 408     char *argv[127];
 409     char *tmp = new char[command.Len() + 1];
 410     strcpy(tmp, command);
 411
 412     argv[argc++] = strtok(tmp, IFS);
 413     while ((argv[argc++] = strtok((char *) NULL, IFS)) != NULL)
 414         /* loop */ ;
 415
 416     long lRc = wxExecute(argv, sync, process);
 417
 418     delete [] tmp;
 419
 420     return lRc;
 421 }