source: git/src/cavernlog.cc @ b3ee5f5

line_contentsstereotravis-osx
Last change on this file since b3ee5f5 was b3ee5f5, checked in by Olly Betts <olly@…>, 5 years ago

src/cavernlog.cc: Rework code to read cavern's output. In
particular, we no longer mix buffered I/O with select() on the
file descriptor.

  • Property mode set to 100644
File size: 11.5 KB
Line 
1/* cavernlog.cc
2 * Run cavern inside an Aven window
3 *
4 * Copyright (C) 2005,2006,2010,2011,2012,2014,2015 Olly Betts
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19 */
20
21#ifdef HAVE_CONFIG_H
22# include <config.h>
23#endif
24
25#include "aven.h"
26#include "cavernlog.h"
27#include "filename.h"
28#include "mainfrm.h"
29#include "message.h"
30
31#include <errno.h>
32#include <stdio.h>
33#include <stdlib.h>
34
35// For select():
36#ifdef HAVE_SYS_SELECT_H
37#include <sys/select.h>
38#endif
39#include <sys/time.h>
40#include <sys/types.h>
41#include <unistd.h>
42
43enum { LOG_REPROCESS = 1234 };
44
45BEGIN_EVENT_TABLE(CavernLogWindow, wxHtmlWindow)
46    EVT_BUTTON(LOG_REPROCESS, CavernLogWindow::OnReprocess)
47    EVT_BUTTON(wxID_OK, CavernLogWindow::OnOK)
48END_EVENT_TABLE()
49
50static wxString escape_for_shell(wxString s, bool protect_dash = false)
51{
52    size_t p = 0;
53#ifdef __WXMSW__
54    bool needs_quotes = false;
55    while (p < s.size()) {
56        wxChar ch = s[p];
57        if (ch < 127) {
58            if (ch == wxT('"')) {
59                s.insert(p, 1, wxT('\\'));
60                ++p;
61                needs_quotes = true;
62            } else if (strchr(" <>&|^", ch)) {
63                needs_quotes = true;
64            }
65        }
66        ++p;
67    }
68    if (needs_quotes) {
69        s.insert(0u, 1, wxT('"'));
70        s += wxT('"');
71    }
72#else
73    if (protect_dash && !s.empty() && s[0u] == '-') {
74        // If the filename starts with a '-', protect it from being
75        // treated as an option by prepending "./".
76        s.insert(0, wxT("./"));
77        p = 2;
78    }
79    while (p < s.size()) {
80        // Exclude a few safe characters which are common in filenames
81        if (!isalnum(s[p]) && strchr("/._-", s[p]) == NULL) {
82            s.insert(p, 1, wxT('\\'));
83            ++p;
84        }
85        ++p;
86    }
87#endif
88    return s;
89}
90
91CavernLogWindow::CavernLogWindow(MainFrm * mainfrm_, wxWindow * parent)
92    : wxHtmlWindow(parent), mainfrm(mainfrm_)
93{
94    int fsize = parent->GetFont().GetPointSize();
95    int sizes[7] = { fsize, fsize, fsize, fsize, fsize, fsize, fsize };
96    SetFonts(wxString(), wxString(), sizes);
97}
98
99void
100CavernLogWindow::OnLinkClicked(const wxHtmlLinkInfo &link)
101{
102    wxString href = link.GetHref();
103    wxString title = link.GetTarget();
104    size_t colon = href.rfind(wxT(':'));
105    if (colon == wxString::npos)
106        return;
107    size_t colon2 = href.rfind(wxT(':'), colon - 1);
108    if (colon2 != wxString::npos) swap(colon, colon2);
109#ifdef __WXMSW__
110    wxString cmd = wxT("notepad $f");
111#elif defined __WXMAC__
112    wxString cmd = wxT("open -t $f");
113#else
114    wxString cmd = wxT("x-terminal-emulator -title $t -e vim +'call cursor($l,$c)' $f");
115    // wxString cmd = wxT("gedit -b $f +$l:$c $f");
116    // wxString cmd = wxT("x-terminal-emulator -title $t -e emacs +$l $f");
117    // wxString cmd = wxT("x-terminal-emulator -title $t -e nano +$l $f");
118    // wxString cmd = wxT("x-terminal-emulator -title $t -e jed -g $l $f");
119#endif
120    const char * p = getenv("SURVEXEDITOR");
121    if (p) {
122        cmd = wxString(p, wxConvUTF8);
123        if (!cmd.find(wxT("$f"))) {
124            cmd += wxT(" $f");
125        }
126    }
127    size_t i = 0;
128    while ((i = cmd.find(wxT('$'), i)) != wxString::npos) {
129        if (++i >= cmd.size()) break;
130        switch ((int)cmd[i]) {
131            case wxT('$'):
132                cmd.erase(i, 1);
133                break;
134            case wxT('f'): {
135                wxString f = escape_for_shell(href.substr(0, colon), true);
136                cmd.replace(i - 1, 2, f);
137                i += f.size() - 1;
138                break;
139            }
140            case wxT('t'): {
141                wxString t = escape_for_shell(title);
142                cmd.replace(i - 1, 2, t);
143                i += t.size() - 1;
144                break;
145            }
146            case wxT('l'): {
147                wxString l = escape_for_shell(href.substr(colon + 1, colon2 - colon - 1));
148                cmd.replace(i - 1, 2, l);
149                i += l.size() - 1;
150                break;
151            }
152            case wxT('c'): {
153                wxString l;
154                if (colon2 == wxString::npos)
155                    l = wxT("0");
156                else
157                    l = escape_for_shell(href.substr(colon2 + 1));
158                cmd.replace(i - 1, 2, l);
159                i += l.size() - 1;
160                break;
161            }
162            default:
163                ++i;
164        }
165    }
166#ifdef __WXMSW__
167    if (_wsystem(cmd.c_str()) >= 0)
168        return;
169#else
170    if (system(cmd.mb_str()) >= 0)
171        return;
172#endif
173    wxString m;
174    // TRANSLATORS: %s is replaced by the command we attempted to run.
175    m.Printf(wmsg(/*Couldn’t run external command: “%s”*/17), cmd.c_str());
176    m += wxT(" (");
177    m += wxString(strerror(errno), wxConvUTF8);
178    m += wxT(')');
179    wxGetApp().ReportError(m);
180}
181
182int
183CavernLogWindow::process(const wxString &file)
184{
185    SetFocus();
186    filename = file;
187
188#ifdef __WXMSW__
189    SetEnvironmentVariable(wxT("SURVEX_UTF8"), wxT("1"));
190#else
191    setenv("SURVEX_UTF8", "1", 1);
192#endif
193
194    wxString escaped_file = escape_for_shell(file, true);
195#ifdef __WXMSW__
196    wxString cmd;
197    {
198        DWORD len = 256;
199        wchar_t *buf = NULL;
200        while (1) {
201            DWORD got;
202            buf = (wchar_t*)osrealloc(buf, len * 2);
203            got = GetModuleFileNameW(NULL, buf, len);
204            if (got < len) break;
205            len += len;
206        }
207        /* Strange Win32 nastiness - strip prefix "\\?\" if present */
208        if (wcsncmp(buf, L"\\\\?\\", 4) == 0) buf += 4;
209        wchar_t * slash = wcsrchr(buf, L'\\');
210        if (slash) {
211            cmd.assign(buf, slash - buf + 1);
212        }
213    }
214    cmd += L"cavern";
215    cmd = escape_for_shell(cmd, false);
216#else
217    char *cavern = use_path(msg_exepth(), "cavern");
218    wxString cmd = escape_for_shell(wxString(cavern, wxConvUTF8), false);
219    osfree(cavern);
220#endif
221    cmd += wxT(" -o ");
222    cmd += escaped_file;
223    cmd += wxT(' ');
224    cmd += escaped_file;
225
226#ifdef __WXMSW__
227    FILE * cavern_out = _wpopen(cmd.c_str(), L"r");
228#else
229    FILE * cavern_out = popen(cmd.mb_str(), "r");
230#endif
231    if (!cavern_out) {
232        wxString m;
233        m.Printf(wmsg(/*Couldn’t run external command: “%s”*/17), cmd.c_str());
234        m += wxT(" (");
235        m += wxString(strerror(errno), wxConvUTF8);
236        m += wxT(')');
237        wxGetApp().ReportError(m);
238        return -2;
239    }
240
241    int cavern_fd;
242#ifdef __WXMSW__
243    cavern_fd = _fileno(cavern_out);
244#else
245    cavern_fd = fileno(cavern_out);
246#endif
247    assert(cavern_fd < FD_SETSIZE); // FIXME we shouldn't just assert, but what else to do?
248    wxString cur;
249    int link_count = 0;
250    unsigned char buf[1024];
251    unsigned char * end = buf;
252    while (true) {
253        fd_set rfds, efds;
254        FD_ZERO(&rfds);
255        FD_SET(cavern_fd, &rfds);
256        FD_ZERO(&efds);
257        FD_SET(cavern_fd, &efds);
258        // Timeout instantly the first time, and call Update() so the window
259        // contents get updated.  If we're still waiting for output after that,
260        // wait for output for 0.1 seconds, then call wxYield() so that the UI
261        // doesn't block.
262        struct timeval timeout;
263        timeout.tv_sec = 0;
264        timeout.tv_usec = 0;
265        bool first = true;
266        while (select(cavern_fd + 1, &rfds, NULL, &efds, &timeout) == 0) {
267            if (first) {
268                first = false;
269                Update();
270            } else {
271                wxYield();
272            }
273            FD_SET(cavern_fd, &rfds);
274            FD_SET(cavern_fd, &efds);
275            // Set timeout to 0.1 seconds.
276            timeout.tv_sec = 0;
277            timeout.tv_usec = 100000;
278        }
279        if (!FD_ISSET(cavern_fd, &rfds)) {
280            // Error, which pclose() should report.
281            break;
282        }
283
284        ssize_t r = read(cavern_fd, end, sizeof(buf) - (end - buf));
285        if (r <= 0) {
286            if (r == 0 && buf != end) {
287                // FIXME: Truncated UTF-8 sequence.
288            }
289            break;
290        }
291        end += r;
292
293        const unsigned char * p = buf;
294
295        while (p != end) {
296            int ch = *p++;
297            if (ch >= 0x80) {
298                // Decode multi-byte UTF-8 sequence.
299                if (ch < 0xc0) {
300                    // FIXME: Invalid UTF-8 sequence.
301                    goto abort;
302                } else if (ch < 0xe0) {
303                    /* 2 byte sequence */
304                    if (p == end) {
305                        // Incomplete UTF-8 sequence - try to read more.
306                        break;
307                    }
308                    int ch1 = *p++;
309                    if ((ch1 & 0xc0) != 0x80) {
310                        // FIXME: Invalid UTF-8 sequence.
311                        goto abort;
312                    }
313                    ch = ((ch & 0x1f) << 6) | (ch1 & 0x3f);
314                } else if (ch < 0xf0) {
315                    /* 3 byte sequence */
316                    if (end - p <= 1) {
317                        // Incomplete UTF-8 sequence - try to read more.
318                        break;
319                    }
320                    int ch1 = *p++;
321                    ch = ((ch & 0x1f) << 12) | ((ch1 & 0x3f) << 6);
322                    if ((ch1 & 0xc0) != 0x80) {
323                        // FIXME: Invalid UTF-8 sequence.
324                        goto abort;
325                    }
326                    int ch2 = *p++;
327                    if ((ch2 & 0xc0) != 0x80) {
328                        // FIXME: Invalid UTF-8 sequence.
329                        goto abort;
330                    }
331                    ch |= (ch2 & 0x3f);
332                } else {
333                    // FIXME: Overlong UTF-8 sequence.
334                    goto abort;
335                }
336            }
337
338            switch (ch) {
339                case '\r':
340                    // Ignore.
341                    break;
342                case '\n': {
343                    if (cur.empty()) continue;
344#ifndef __WXMSW__
345                    size_t colon = cur.find(':');
346#else
347                    // If the path is "C:\path\to\file.svx" then don't split at the
348                    // : after the drive letter!  FIXME: better to look for ": "?
349                    size_t colon = cur.find(':', 2);
350#endif
351                    if (colon != wxString::npos && colon < cur.size() - 2) {
352                        ++colon;
353                        size_t i = colon;
354                        while (i < cur.size() - 2 &&
355                               cur[i] >= wxT('0') && cur[i] <= wxT('9')) {
356                            ++i;
357                        }
358                        if (i > colon && cur[i] == wxT(':') ) {
359                            colon = i;
360                            // Check for column number.
361                            while (++i < cur.size() - 2 &&
362                               cur[i] >= wxT('0') && cur[i] <= wxT('9')) { }
363                            if (i > colon + 1 && cur[i] == wxT(':') ) {
364                                colon = i;
365                            }
366                            wxString tag = wxT("<a href=\"");
367                            tag.append(cur, 0, colon);
368                            while (cur[++i] == wxT(' ')) { }
369                            tag += wxT("\" target=\"");
370                            tag.append(cur, i, wxString::npos);
371                            tag += wxT("\">");
372                            cur.insert(0, tag);
373                            cur.insert(colon + tag.size(), wxT("</a>"));
374                            ++link_count;
375                        }
376                    }
377
378                    // Save the scrollbar positions.
379                    int scroll_x = 0, scroll_y = 0;
380                    GetViewStart(&scroll_x, &scroll_y);
381
382                    cur += wxT("<br>\n");
383                    AppendToPage(cur);
384
385                    if (!link_count) {
386                        // Auto-scroll the window until we've reported a warning or
387                        // error.
388                        int x, y;
389                        GetVirtualSize(&x, &y);
390                        int xs, ys;
391                        GetClientSize(&xs, &ys);
392                        y -= ys;
393                        int xu, yu;
394                        GetScrollPixelsPerUnit(&xu, &yu);
395                        Scroll(scroll_x, y / yu);
396                    } else {
397                        // Restore the scrollbar positions.
398                        Scroll(scroll_x, scroll_y);
399                    }
400
401                    cur.clear();
402                    break;
403                }
404                case '<':
405                    cur += wxT("&lt;");
406                    break;
407                case '>':
408                    cur += wxT("&gt;");
409                    break;
410                case '&':
411                    cur += wxT("&amp;");
412                    break;
413                case '"':
414                    cur += wxT("&#22;");
415                    continue;
416                default:
417                    if (ch >= 128) {
418                        cur += wxString::Format(wxT("&#%u;"), ch);
419                    } else {
420                        cur += (char)ch;
421                    }
422            }
423        }
424
425        size_t left = end - p;
426        end = buf + left;
427        if (left) memmove(buf, p, left);
428    }
429abort:
430
431    int retval = pclose(cavern_out);
432    if (retval) {
433        /* TRANSLATORS: Label for button in aven’s cavern log window which
434         * causes the survey data to be reprocessed. */
435        AppendToPage(wxString::Format(wxT("<avenbutton default id=1234 name=\"%s\">"),
436                                      wmsg(/*Reprocess*/184).c_str()));
437        if (retval == -1) {
438            wxString m = wxT("Problem running cavern: ");
439            m += wxString(strerror(errno), wxConvUTF8);
440            wxGetApp().ReportError(m);
441            return -2;
442        }
443        return -1;
444    }
445    if (link_count) {
446        AppendToPage(wxString::Format(wxT("<avenbutton id=1234 name=\"%s\">"),
447                                      wmsg(/*Reprocess*/184).c_str()));
448        AppendToPage(wxString::Format(wxT("<avenbutton default id=%d>"), (int)wxID_OK));
449        Update();
450    }
451    return link_count;
452}
453
454void
455CavernLogWindow::OnReprocess(wxCommandEvent & e)
456{
457    SetPage(wxString());
458    if (process(filename) == 0) {
459        OnOK(e);
460    }
461}
462
463void
464CavernLogWindow::OnOK(wxCommandEvent &)
465{
466    mainfrm->InitialiseAfterLoad(filename);
467}
Note: See TracBrowser for help on using the repository browser.