]> git.saurik.com Git - wxWidgets.git/blob - src/unix/utilsunx.cpp
Inserted "stdio catch" in wxExecute. The activation is controlled by wxProcess.
[wxWidgets.git] / src / unix / utilsunx.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: utilsunx.cpp
3 // Purpose: generic Unix implementation of many wx functions
4 // Author: Vadim Zeitlin
5 // Id: $Id$
6 // Copyright: (c) 1998 Robert Roebling, Vadim Zeitlin
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
9
10 // ============================================================================
11 // declarations
12 // ============================================================================
13
14 // ----------------------------------------------------------------------------
15 // headers
16 // ----------------------------------------------------------------------------
17
18 #include "wx/defs.h"
19 #include "wx/string.h"
20
21 #include "wx/intl.h"
22 #include "wx/log.h"
23
24 #include "wx/utils.h"
25 #include "wx/process.h"
26 #include "wx/thread.h"
27
28 #include "wx/stream.h"
29
30 #if wxUSE_GUI
31 #include "wx/unix/execute.h"
32 #endif
33
34 #include <stdarg.h>
35 #include <dirent.h>
36 #include <string.h>
37 #include <sys/stat.h>
38 #include <sys/types.h>
39 #include <unistd.h>
40 #include <sys/wait.h>
41 #include <pwd.h>
42 #include <errno.h>
43 #include <netdb.h>
44 #include <signal.h>
45 #include <fcntl.h> // for O_WRONLY and friends
46 #include <time.h> // nanosleep() and/or usleep()
47 #include <ctype.h> // isspace()
48 #include <sys/time.h> // needed for FD_SETSIZE
49
50 #ifdef HAVE_UNAME
51 #include <sys/utsname.h> // for uname()
52 #endif // HAVE_UNAME
53
54 // ----------------------------------------------------------------------------
55 // conditional compilation
56 // ----------------------------------------------------------------------------
57
58 // many versions of Unices have this function, but it is not defined in system
59 // headers - please add your system here if it is the case for your OS.
60 // SunOS < 5.6 (i.e. Solaris < 2.6) and DG-UX are like this.
61 #if !defined(HAVE_USLEEP) && \
62 (defined(__SUN__) && !defined(__SunOs_5_6) && \
63 !defined(__SunOs_5_7) && !defined(__SUNPRO_CC)) || \
64 defined(__osf__) || defined(__EMX__)
65 extern "C"
66 {
67 #ifdef __SUN__
68 int usleep(unsigned int usec);
69 #else // !Sun
70 #ifdef __EMX__
71 /* I copied this from the XFree86 diffs. AV. */
72 #define INCL_DOSPROCESS
73 #include <os2.h>
74 inline void usleep(unsigned long delay)
75 {
76 DosSleep(delay ? (delay/1000l) : 1l);
77 }
78 #else // !Sun && !EMX
79 void usleep(unsigned long usec);
80 #endif
81 #endif // Sun/EMX/Something else
82 };
83
84 #define HAVE_USLEEP 1
85 #endif // Unices without usleep()
86
87 // ============================================================================
88 // implementation
89 // ============================================================================
90
91 // ----------------------------------------------------------------------------
92 // sleeping
93 // ----------------------------------------------------------------------------
94
95 void wxSleep(int nSecs)
96 {
97 sleep(nSecs);
98 }
99
100 void wxUsleep(unsigned long milliseconds)
101 {
102 #if defined(HAVE_NANOSLEEP)
103 timespec tmReq;
104 tmReq.tv_sec = (time_t)(milliseconds / 1000);
105 tmReq.tv_nsec = (milliseconds % 1000) * 1000 * 1000;
106
107 // we're not interested in remaining time nor in return value
108 (void)nanosleep(&tmReq, (timespec *)NULL);
109 #elif defined(HAVE_USLEEP)
110 // uncomment this if you feel brave or if you are sure that your version
111 // of Solaris has a safe usleep() function but please notice that usleep()
112 // is known to lead to crashes in MT programs in Solaris 2.[67] and is not
113 // documented as MT-Safe
114 #if defined(__SUN__) && wxUSE_THREADS
115 #error "usleep() cannot be used in MT programs under Solaris."
116 #endif // Sun
117
118 usleep(milliseconds * 1000); // usleep(3) wants microseconds
119 #elif defined(HAVE_SLEEP)
120 // under BeOS sleep() takes seconds (what about other platforms, if any?)
121 sleep(milliseconds * 1000);
122 #else // !sleep function
123 #error "usleep() or nanosleep() function required for wxUsleep"
124 #endif // sleep function
125 }
126
127 // ----------------------------------------------------------------------------
128 // process management
129 // ----------------------------------------------------------------------------
130
131 int wxKill(long pid, wxSignal sig)
132 {
133 return kill((pid_t)pid, (int)sig);
134 }
135
136 #define WXEXECUTE_NARGS 127
137
138 long wxExecute( const wxString& command, bool sync, wxProcess *process )
139 {
140 wxCHECK_MSG( !command.IsEmpty(), 0, wxT("can't exec empty command") );
141
142 int argc = 0;
143 wxChar *argv[WXEXECUTE_NARGS];
144 wxString argument;
145 const wxChar *cptr = command.c_str();
146 wxChar quotechar = wxT('\0'); // is arg quoted?
147 bool escaped = FALSE;
148
149 // split the command line in arguments
150 do
151 {
152 argument=wxT("");
153 quotechar = wxT('\0');
154
155 // eat leading whitespace:
156 while ( wxIsspace(*cptr) )
157 cptr++;
158
159 if ( *cptr == wxT('\'') || *cptr == wxT('"') )
160 quotechar = *cptr++;
161
162 do
163 {
164 if ( *cptr == wxT('\\') && ! escaped )
165 {
166 escaped = TRUE;
167 cptr++;
168 continue;
169 }
170
171 // all other characters:
172 argument += *cptr++;
173 escaped = FALSE;
174
175 // have we reached the end of the argument?
176 if ( (*cptr == quotechar && ! escaped)
177 || (quotechar == wxT('\0') && wxIsspace(*cptr))
178 || *cptr == wxT('\0') )
179 {
180 wxASSERT_MSG( argc < WXEXECUTE_NARGS,
181 wxT("too many arguments in wxExecute") );
182
183 argv[argc] = new wxChar[argument.length() + 1];
184 wxStrcpy(argv[argc], argument.c_str());
185 argc++;
186
187 // if not at end of buffer, swallow last character:
188 if(*cptr)
189 cptr++;
190
191 break; // done with this one, start over
192 }
193 } while(*cptr);
194 } while(*cptr);
195 argv[argc] = NULL;
196
197 // do execute the command
198 long lRc = wxExecute(argv, sync, process);
199
200 // clean up
201 argc = 0;
202 while( argv[argc] )
203 delete [] argv[argc++];
204
205 return lRc;
206 }
207
208 bool wxShell(const wxString& command)
209 {
210 wxString cmd;
211 if ( !!command )
212 cmd.Printf(wxT("xterm -e %s"), command.c_str());
213 else
214 cmd = command;
215
216 return wxExecute(cmd) != 0;
217 }
218
219 #if wxUSE_GUI
220
221 void wxHandleProcessTermination(wxEndProcessData *proc_data)
222 {
223 int pid = (proc_data->pid > 0) ? proc_data->pid : -(proc_data->pid);
224
225 // waitpid is POSIX so should be available everywhere, however on older
226 // systems wait() might be used instead in a loop (until the right pid
227 // terminates)
228 int status = 0;
229 int rc;
230
231 // wait for child termination and if waitpid() was interrupted, try again
232 do
233 {
234 rc = waitpid(pid, &status, 0);
235 }
236 while ( rc == -1 && errno == EINTR );
237
238
239 if( rc == -1 || ! (WIFEXITED(status) || WIFSIGNALED(status)) )
240 {
241 wxLogSysError(_("Waiting for subprocess termination failed"));
242 /* AFAIK, this can only happen if something went wrong within
243 wxGTK, i.e. due to a race condition or some serious bug.
244 After having fixed the order of statements in
245 GTK_EndProcessDetector(). (KB)
246 */
247 }
248 else
249 {
250 // notify user about termination if required
251 if (proc_data->process)
252 {
253 proc_data->process->OnTerminate(proc_data->pid,
254 WEXITSTATUS(status));
255 }
256 // clean up
257 if ( proc_data->pid > 0 )
258 {
259 delete proc_data;
260 }
261 else
262 {
263 // wxExecute() will know about it
264 proc_data->exitcode = status;
265
266 proc_data->pid = 0;
267 }
268 }
269 }
270
271 #endif // wxUSE_GUI
272
273 #if wxUSE_GUI
274 #define WXUNUSED_UNLESS_GUI(p) p
275 #else
276 #define WXUNUSED_UNLESS_GUI(p)
277 #endif
278
279 // New wxStream classes to clean up the data when the process terminates
280
281 #if wxUSE_GUI
282 class wxProcessFileInputStream: public wxInputStream {
283 public:
284 wxProcessFileInputStream(int fd);
285 ~wxProcessFileInputStream();
286
287 protected:
288 size_t OnSysRead(void *buffer, size_t bufsize);
289
290 protected:
291 int m_fd;
292 };
293
294 class wxProcessFileOutputStream: public wxOutputStream {
295 public:
296 wxProcessFileOutputStream(int fd);
297 ~wxProcessFileOutputStream();
298
299 protected:
300 size_t OnSysWrite(const void *buffer, size_t bufsize);
301
302 protected:
303 int m_fd;
304 };
305
306 wxProcessFileInputStream::wxProcessFileInputStream(int fd)
307 {
308 m_fd = fd;
309 }
310
311 wxProcessFileInputStream::~wxProcessFileInputStream()
312 {
313 close(m_fd);
314 }
315
316 size_t wxProcessFileInputStream::OnSysRead(void *buffer, size_t bufsize)
317 {
318 int ret;
319
320 ret = read(m_fd, buffer, bufsize);
321 m_lasterror = wxSTREAM_NOERROR;
322 if (ret == 0)
323 m_lasterror = wxSTREAM_EOF;
324 if (ret == -1) {
325 m_lasterror = wxSTREAM_READ_ERROR;
326 ret = 0;
327 }
328 return ret;
329 }
330
331 wxProcessFileOutputStream::wxProcessFileOutputStream(int fd)
332 {
333 m_fd = fd;
334 }
335
336 wxProcessFileOutputStream::~wxProcessFileOutputStream()
337 {
338 close(m_fd);
339 }
340
341 size_t wxProcessFileOutputStream::OnSysWrite(const void *buffer, size_t bufsize)
342 {
343 int ret;
344
345 ret = write(m_fd, buffer, bufsize);
346 m_lasterror = wxSTREAM_NOERROR;
347 if (ret == -1) {
348 m_lasterror = wxSTREAM_WRITE_ERROR;
349 ret = 0;
350 }
351 return ret;
352 }
353
354 #endif
355
356 long wxExecute(wxChar **argv,
357 bool sync,
358 wxProcess * WXUNUSED_UNLESS_GUI(process))
359 {
360 wxCHECK_MSG( *argv, 0, wxT("can't exec empty command") );
361
362 #if wxUSE_UNICODE
363 int mb_argc = 0;
364 char *mb_argv[WXEXECUTE_NARGS];
365
366 while (argv[mb_argc])
367 {
368 wxWX2MBbuf mb_arg = wxConvertWX2MB(argv[mb_argc]);
369 mb_argv[mb_argc] = strdup(mb_arg);
370 mb_argc++;
371 }
372 mb_argv[mb_argc] = (char *) NULL;
373
374 // this macro will free memory we used above
375 #define ARGS_CLEANUP \
376 for ( mb_argc = 0; mb_argv[mb_argc]; mb_argc++ ) \
377 free(mb_argv[mb_argc])
378 #else // ANSI
379 // no need for cleanup
380 #define ARGS_CLEANUP
381
382 wxChar **mb_argv = argv;
383 #endif // Unicode/ANSI
384
385 #if wxUSE_GUI
386 // create pipes
387 int end_proc_detect[2];
388 if (pipe(end_proc_detect) == -1)
389 {
390 wxLogSysError( _("Pipe creation failed") );
391
392 ARGS_CLEANUP;
393
394 return 0;
395 }
396 #endif // wxUSE_GUI
397
398 #if wxUSE_GUI
399 int in_pipe[2] = { -1, -1 };
400 int out_pipe[2] = { -1, -1 };
401 // Only asynchronous mode is interresting
402 if (!sync && process && process->NeedPipe())
403 {
404 if (pipe(in_pipe) == -1 || pipe(out_pipe) == -1)
405 {
406 /* Free fds */
407 close(end_proc_detect[0]);
408 close(end_proc_detect[1]);
409 wxLogSysError( _("Pipe creation failed (Console pipes)") );
410
411 ARGS_CLEANUP;
412
413 return 0;
414 }
415 }
416 #endif // wxUSE_GUI
417
418 // fork the process
419 #ifdef HAVE_VFORK
420 pid_t pid = vfork();
421 #else
422 pid_t pid = fork();
423 #endif
424 if (pid == -1)
425 {
426 #if wxUSE_GUI
427 close(end_proc_detect[0]);
428 close(end_proc_detect[1]);
429 close(in_pipe[0]);
430 close(in_pipe[1]);
431 close(out_pipe[0]);
432 close(out_pipe[1]);
433 #endif
434 wxLogSysError( _("Fork failed") );
435
436 ARGS_CLEANUP;
437
438 return 0;
439 }
440 else if (pid == 0)
441 {
442 #if wxUSE_GUI
443 // we're in child
444 close(end_proc_detect[0]); // close reading side
445 #endif // wxUSE_GUI
446
447 // These three lines close the open file descriptors to to avoid any
448 // input/output which might block the process or irritate the user. If
449 // one wants proper IO for the subprocess, the right thing to do is
450 // to start an xterm executing it.
451 if (sync == 0)
452 {
453 // leave stderr opened, it won't do any hurm
454 for ( int fd = 0; fd < FD_SETSIZE; fd++ )
455 {
456 #if wxUSE_GUI
457 if ( fd == end_proc_detect[1] || fd == in_pipe[0] || fd == out_pipe[1] )
458 continue;
459 #endif // wxUSE_GUI
460
461 if ( fd != STDERR_FILENO )
462 close(fd);
463 }
464 }
465
466 // Fake a console by duplicating pipes
467 #if wxUSE_GUI
468 if (in_pipe[0] != -1) {
469 dup2(in_pipe[0], STDIN_FILENO);
470 dup2(out_pipe[1], STDOUT_FILENO);
471 close(in_pipe[0]);
472 close(out_pipe[1]);
473 }
474 #endif // wxUSE_GUI
475
476 #if 0
477 close(STDERR_FILENO);
478
479 // some programs complain about stderr not being open, so redirect
480 // them:
481 open("/dev/null", O_RDONLY); // stdin
482 open("/dev/null", O_WRONLY); // stdout
483 open("/dev/null", O_WRONLY); // stderr
484 #endif
485
486 execvp (*mb_argv, mb_argv);
487
488 // there is no return after successful exec()
489 wxFprintf(stderr, _("Can't execute '%s'\n"), *argv);
490
491 _exit(-1);
492 }
493 else
494 {
495 #if wxUSE_GUI
496 wxEndProcessData *data = new wxEndProcessData;
497
498 ARGS_CLEANUP;
499
500 if ( sync )
501 {
502 wxASSERT_MSG( !process, wxT("wxProcess param ignored for sync exec") );
503 data->process = NULL;
504
505 // sync execution: indicate it by negating the pid
506 data->pid = -pid;
507 data->tag = wxAddProcessCallback(data, end_proc_detect[0]);
508 // we're in parent
509 close(end_proc_detect[1]); // close writing side
510
511 // it will be set to 0 from GTK_EndProcessDetector
512 while (data->pid != 0)
513 wxYield();
514
515 int exitcode = data->exitcode;
516
517 delete data;
518
519 return exitcode;
520 }
521 else
522 {
523 // pipe initialization: construction of the wxStreams
524 if (process && process->NeedPipe()) {
525 // These two streams are relative to this process.
526 wxOutputStream *my_output_stream;
527 wxInputStream *my_input_stream;
528
529 my_output_stream = new wxProcessFileOutputStream(in_pipe[1]);
530 my_input_stream = new wxProcessFileInputStream(out_pipe[0]);
531 close(in_pipe[0]); // close reading side
532 close(out_pipe[1]); // close writing side
533
534 process->SetPipeStreams(my_input_stream, my_output_stream);
535 }
536
537 // async execution, nothing special to do - caller will be
538 // notified about the process termination if process != NULL, data
539 // will be deleted in GTK_EndProcessDetector
540 data->process = process;
541 data->pid = pid;
542 data->tag = wxAddProcessCallback(data, end_proc_detect[0]);
543 // we're in parent
544 close(end_proc_detect[1]); // close writing side
545
546 return pid;
547 }
548 #else // !wxUSE_GUI
549 wxASSERT_MSG( sync, wxT("async execution not supported yet") );
550
551 int exitcode = 0;
552 if ( waitpid(pid, &exitcode, 0) == -1 || !WIFEXITED(exitcode) )
553 {
554 wxLogSysError(_("Waiting for subprocess termination failed"));
555 }
556
557 return exitcode;
558 #endif // wxUSE_GUI
559 }
560 return 0;
561
562 #undef ARGS_CLEANUP
563 }
564
565 // ----------------------------------------------------------------------------
566 // file and directory functions
567 // ----------------------------------------------------------------------------
568
569 const wxChar* wxGetHomeDir( wxString *home )
570 {
571 *home = wxGetUserHome( wxString() );
572 if ( home->IsEmpty() )
573 *home = wxT("/");
574
575 return home->c_str();
576 }
577
578 #if wxUSE_UNICODE
579 const wxMB2WXbuf wxGetUserHome( const wxString &user )
580 #else // just for binary compatibility -- there is no 'const' here
581 char *wxGetUserHome( const wxString &user )
582 #endif
583 {
584 struct passwd *who = (struct passwd *) NULL;
585
586 if ( !user )
587 {
588 wxChar *ptr;
589
590 if ((ptr = wxGetenv(wxT("HOME"))) != NULL)
591 {
592 return ptr;
593 }
594 if ((ptr = wxGetenv(wxT("USER"))) != NULL || (ptr = wxGetenv(wxT("LOGNAME"))) != NULL)
595 {
596 who = getpwnam(wxConvertWX2MB(ptr));
597 }
598
599 // We now make sure the the user exists!
600 if (who == NULL)
601 {
602 who = getpwuid(getuid());
603 }
604 }
605 else
606 {
607 who = getpwnam (user.mb_str());
608 }
609
610 return wxConvertMB2WX(who ? who->pw_dir : 0);
611 }
612
613 // ----------------------------------------------------------------------------
614 // network and user id routines
615 // ----------------------------------------------------------------------------
616
617 // retrieve either the hostname or FQDN depending on platform (caller must
618 // check whether it's one or the other, this is why this function is for
619 // private use only)
620 static bool wxGetHostNameInternal(wxChar *buf, int sz)
621 {
622 wxCHECK_MSG( buf, FALSE, wxT("NULL pointer in wxGetHostNameInternal") );
623
624 *buf = wxT('\0');
625
626 // we're using uname() which is POSIX instead of less standard sysinfo()
627 #if defined(HAVE_UNAME)
628 struct utsname uts;
629 bool ok = uname(&uts) != -1;
630 if ( ok )
631 {
632 wxStrncpy(buf, wxConvertMB2WX(uts.nodename), sz - 1);
633 buf[sz] = wxT('\0');
634 }
635 #elif defined(HAVE_GETHOSTNAME)
636 bool ok = gethostname(buf, sz) != -1;
637 #else // no uname, no gethostname
638 wxFAIL_MSG(wxT("don't know host name for this machine"));
639
640 bool ok = FALSE;
641 #endif // uname/gethostname
642
643 if ( !ok )
644 {
645 wxLogSysError(_("Cannot get the hostname"));
646 }
647
648 return ok;
649 }
650
651 bool wxGetHostName(wxChar *buf, int sz)
652 {
653 bool ok = wxGetHostNameInternal(buf, sz);
654
655 if ( ok )
656 {
657 // BSD systems return the FQDN, we only want the hostname, so extract
658 // it (we consider that dots are domain separators)
659 wxChar *dot = wxStrchr(buf, wxT('.'));
660 if ( dot )
661 {
662 // nuke it
663 *dot = wxT('\0');
664 }
665 }
666
667 return ok;
668 }
669
670 bool wxGetFullHostName(wxChar *buf, int sz)
671 {
672 bool ok = wxGetHostNameInternal(buf, sz);
673
674 if ( ok )
675 {
676 if ( !wxStrchr(buf, wxT('.')) )
677 {
678 struct hostent *host = gethostbyname(wxConvertWX2MB(buf));
679 if ( !host )
680 {
681 wxLogSysError(_("Cannot get the official hostname"));
682
683 ok = FALSE;
684 }
685 else
686 {
687 // the canonical name
688 wxStrncpy(buf, wxConvertMB2WX(host->h_name), sz);
689 }
690 }
691 //else: it's already a FQDN (BSD behaves this way)
692 }
693
694 return ok;
695 }
696
697 bool wxGetUserId(wxChar *buf, int sz)
698 {
699 struct passwd *who;
700
701 *buf = wxT('\0');
702 if ((who = getpwuid(getuid ())) != NULL)
703 {
704 wxStrncpy (buf, wxConvertMB2WX(who->pw_name), sz - 1);
705 return TRUE;
706 }
707
708 return FALSE;
709 }
710
711 bool wxGetUserName(wxChar *buf, int sz)
712 {
713 struct passwd *who;
714
715 *buf = wxT('\0');
716 if ((who = getpwuid (getuid ())) != NULL)
717 {
718 // pw_gecos field in struct passwd is not standard
719 #if HAVE_PW_GECOS
720 char *comma = strchr(who->pw_gecos, ',');
721 if (comma)
722 *comma = '\0'; // cut off non-name comment fields
723 wxStrncpy (buf, wxConvertMB2WX(who->pw_gecos), sz - 1);
724 #else // !HAVE_PW_GECOS
725 wxStrncpy (buf, wxConvertMB2WX(who->pw_name), sz - 1);
726 #endif // HAVE_PW_GECOS/!HAVE_PW_GECOS
727 return TRUE;
728 }
729
730 return FALSE;
731 }
732
733 wxString wxGetOsDescription()
734 {
735 #ifndef WXWIN_OS_DESCRIPTION
736 #error WXWIN_OS_DESCRIPTION should be defined in config.h by configure
737 #else
738 return WXWIN_OS_DESCRIPTION;
739 #endif
740 }
741
742 // ----------------------------------------------------------------------------
743 // error and debug output routines (deprecated, use wxLog)
744 // ----------------------------------------------------------------------------
745
746 void wxDebugMsg( const char *format, ... )
747 {
748 va_list ap;
749 va_start( ap, format );
750 vfprintf( stderr, format, ap );
751 fflush( stderr );
752 va_end(ap);
753 }
754
755 void wxError( const wxString &msg, const wxString &title )
756 {
757 wxFprintf( stderr, _("Error ") );
758 if (!title.IsNull()) wxFprintf( stderr, wxT("%s "), WXSTRINGCAST(title) );
759 if (!msg.IsNull()) wxFprintf( stderr, wxT(": %s"), WXSTRINGCAST(msg) );
760 wxFprintf( stderr, wxT(".\n") );
761 }
762
763 void wxFatalError( const wxString &msg, const wxString &title )
764 {
765 wxFprintf( stderr, _("Error ") );
766 if (!title.IsNull()) wxFprintf( stderr, wxT("%s "), WXSTRINGCAST(title) );
767 if (!msg.IsNull()) wxFprintf( stderr, wxT(": %s"), WXSTRINGCAST(msg) );
768 wxFprintf( stderr, wxT(".\n") );
769 exit(3); // the same exit code as for abort()
770 }
771