source: git/src/cavernlog.cc @ 2e4b8cd

RELEASE/1.1RELEASE/1.2debug-cidebug-ci-sanitisersstereowalls-data
Last change on this file since 2e4b8cd was 2e4b8cd, checked in by Olly Betts <olly@…>, 14 years ago

src/cavernlog.cc: Whitespace tweaks.

git-svn-id: file:///home/survex-svn/survex/branches/survex-1_1@3371 4b37db11-9a0c-4f06-9ece-9ab7cdaee568

  • Property mode set to 100644
File size: 8.2 KB
Line 
1/* cavernlog.cc
2 * Run cavern inside an Aven window
3 *
4 * Copyright (C) 2005,2006 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 "message.h"
29
30#include <errno.h>
31#include <stdio.h>
32
33// For select():
34#ifdef HAVE_SYS_SELECT_H
35#include <sys/select.h>
36#endif
37#include <sys/time.h>
38#include <sys/types.h>
39#include <unistd.h>
40
41static wxString escape_for_shell(wxString s, bool protect_dash = false)
42{
43    size_t p = 0;
44#ifdef __WXMSW__
45    bool needs_quotes = false;
46    while (p < s.size()) {
47        if (p == '"') {
48            s.insert(p, '\\');
49            ++p;
50            needs_quotes = true;
51        }
52        ++p;
53    }
54    if (needs_quotes) {
55        s.insert(0, '"');
56        s += '"';
57    }
58#else
59    if (protect_dash && !s.empty() && s[0u] == '-') {
60        // If the filename starts with a '-', protect it from being
61        // treated as an option by prepending "./".
62        s.insert(0, wxT("./"));
63        p = 2;
64    }
65    while (p < s.size()) {
66        // Exclude a few safe characters which are common in filenames
67        if (!isalnum(s[p]) && strchr("/._-", s[p]) == NULL) {
68            s.insert(p, wxT('\\'));
69            ++p;
70        }
71        ++p;
72    }
73#endif
74    return s;
75}
76
77static wxString
78html_escape(const wxString &str)
79{
80    wxString res;
81    size_t p = 0;
82    while (p < str.size()) {
83        char ch = str[p++];
84        switch (ch) {
85            case '<':
86                res += wxT("&lt;");
87                continue;
88            case '>':
89                res += wxT("&gt;");
90                continue;
91            case '&':
92                res += wxT("&amp;");
93                continue;
94            case '"':
95                res += wxT("&quot;");
96                continue;
97            default:
98                res += ch;
99        }
100    }
101    return res;
102}
103
104CavernLogWindow::CavernLogWindow(wxWindow * parent) : wxHtmlWindow(parent) {
105    //GetParser()->SetInputEncoding(wxFONTENCODING_UTF8);
106    int fsize = parent->GetFont().GetPointSize();
107    int sizes[7] = { fsize, fsize, fsize, fsize, fsize, fsize, fsize };
108    SetFonts(wxString(), wxString(), sizes);
109    //GetParser()->SetInputEncoding(wxFONTENCODING_UTF8);
110}
111
112void
113CavernLogWindow::OnLinkClicked(const wxHtmlLinkInfo &link)
114{
115    wxString href = link.GetHref();
116    wxString title = link.GetTarget();
117    size_t colon = href.rfind(wxT(':'));
118    if (colon != wxString::npos) {
119#ifdef __WXMSW__
120        wxString cmd = wxT("notepad $f");
121#else
122        wxString cmd = wxT("x-terminal-emulator -title $t -e vim -c $l $f");
123        // wxString cmd = "x-terminal-emulator -title $t -e emacs +$l $f";
124        // wxString cmd = "x-terminal-emulator -title $t -e nano +$l $f";
125        // wxString cmd = "x-terminal-emulator -title $t -e jed -g $l $f";
126#endif
127        const char * p = getenv("SURVEXEDITOR");
128        if (p) {
129            cmd = wxString(p, wxConvUTF8);
130            if (!cmd.find(wxT("$f"))) {
131                cmd += wxT(" $f");
132            }
133        }
134        size_t i = 0;
135        while ((i = cmd.find(wxT('$'), i)) != wxString::npos) {
136            if (++i >= cmd.size()) break;
137                switch (cmd[i]) {
138                    case wxT('$'):
139                        cmd.erase(i, 1);
140                        break;
141                    case wxT('f'): {
142                        wxString f = escape_for_shell(href.substr(0, colon), true);
143                        cmd.replace(i - 1, 2, f);
144                        i += f.size() - 1;
145                        break;
146                    }
147                    case wxT('t'): {
148                        wxString t = escape_for_shell(title);
149                        cmd.replace(i - 1, 2, t);
150                        i += t.size() - 1;
151                        break;
152                    }
153                    case wxT('l'): {
154                        wxString l = escape_for_shell(href.substr(colon + 1));
155                        cmd.replace(i - 1, 2, l);
156                        i += l.size() - 1;
157                        break;
158                    }
159                    default:
160                        ++i;
161                }
162        }
163        system(cmd.fn_str());
164    }
165}
166
167int
168CavernLogWindow::process(const wxString &file)
169{
170    char *cavern = use_path(msg_exepth(), "cavern");
171#ifdef __WXMSW__
172    SetEnvironmentVariable("SURVEX_UTF8", "1");
173#else
174    setenv("SURVEX_UTF8", "1", 1);
175#endif
176
177    wxString escaped_file = escape_for_shell(file, true);
178    wxString cmd = escape_for_shell(wxString(cavern, wxConvUTF8), false);
179    osfree(cavern);
180    cmd += wxT(" -o ");
181    cmd += escaped_file;
182    cmd += wxT(' ');
183    cmd += escaped_file;
184
185    FILE * cavern_out = popen(cmd.fn_str(), "r");
186    if (!cavern_out) {
187        wxString m;
188        m.Printf(wmsg(/*Couldn't open pipe: `%s'*/17), cmd.c_str());
189        m += wxT(" (");
190        m += wxString(strerror(errno), wxConvUTF8);
191        m += wxT(')');
192        wxGetApp().ReportError(m);
193        return -2;
194    }
195
196    int cavern_fd;
197#ifdef __WXMSW__
198    cavern_fd = _fileno(cavern_out);
199#else
200    cavern_fd = fileno(cavern_out);
201#endif
202    assert(cavern_fd < FD_SETSIZE); // FIXME we shouldn't just assert, but what else to do?
203    wxString cur;
204    int link_count = 0;
205    // We're only guaranteed one character of pushback by ungetc() but we
206    // need two so for portability we implement the second ourselves.
207    int left = EOF;
208    while (!feof(cavern_out)) {
209        fd_set rfds, efds;
210        FD_ZERO(&rfds);
211        FD_SET(cavern_fd, &rfds);
212        FD_ZERO(&efds);
213        FD_SET(cavern_fd, &efds);
214        struct timeval timeout;
215        timeout.tv_sec = 0;
216        timeout.tv_usec = 10;
217        if (select(cavern_fd + 1, &rfds, NULL, &efds, &timeout) == 0) {
218            wxYield();
219            continue;
220        }
221        if (!FD_ISSET(cavern_fd, &rfds)) {
222            // Error, which pclose() should report.
223            break;
224        }
225        int ch;
226        if (left == EOF) {
227            ch = getc(cavern_out);
228            if (ch == EOF) break;
229        } else {
230            ch = left;
231            left = EOF;
232        }
233        // Decode UTF-8 first to avoid security issues with <, >, &, etc
234        // encoded using multibyte encodings.
235        if (ch >= 0xc0 && ch < 0xf0) {
236            int ch1 = getc(cavern_out);
237            if ((ch1 & 0xc0) != 0x80) {
238                left = ch1;
239            } else if (ch < 0xe0) {
240                /* 2 byte sequence */
241                ch = ((ch & 0x1f) << 6) | (ch1 & 0x3f);
242            } else {
243                /* 3 byte sequence */
244                int ch2 = getc(cavern_out);
245                if ((ch2 & 0xc0) != 0x80) {
246                    ungetc(ch2, cavern_out);
247                    left = ch1;
248                } else {
249                    ch = ((ch & 0x1f) << 12) | ((ch1 & 0x3f) << 6) | (ch2 & 0x3f);
250                }
251            }
252        }
253
254        switch (ch) {
255            case '\r':
256                // Ignore.
257                break;
258            case '\n': {
259                if (cur.empty()) continue;
260                size_t colon = cur.find(':');
261#ifdef __WXMSW__
262                // If the path is "C:\path\to\file.svx" then don't split at the
263                // : after the drive letter!  FIXME: better to look for ": "?
264                if (colon == 1) colon = cur.find(':', 2);
265#endif
266                if (colon != wxString::npos) {
267                    size_t colon2 = cur.find(':', colon + 1);
268                    if (colon2 != wxString::npos && colon2 != cur.size() - 1) {
269                        wxString href = cur.substr(0, colon2);
270                        while (++colon2 < cur.size()) {
271                            if (cur[colon2] != ' ') break;
272                        }
273                        wxString title = cur.substr(colon2);
274                        cur.insert(colon2, wxT("</a>"));
275                        wxString tag = wxT("<a href=\"");
276                        tag += html_escape(href);
277                        tag += wxT("\" target=\"");
278                        tag += html_escape(title);
279                        tag += wxT("\">");
280                        cur.insert(0, tag);
281                        ++link_count;
282                    }
283                }
284
285                // Save the scrollbar positions.
286                int scroll_x = 0, scroll_y = 0;
287                GetViewStart(&scroll_x, &scroll_y);
288
289                cur += wxT("<br>\n");
290                AppendToPage(cur);
291
292                // Restore the scrollbar positions.
293                Scroll(scroll_x, scroll_y);
294
295                if (!link_count) {
296                    // Auto-scroll the window until we've reported a warning or
297                    // error.
298                    int x, y;
299                    GetVirtualSize(&x, &y);
300                    int xs, ys;
301                    GetClientSize(&xs, &ys);
302                    y -= ys;
303                    int xu, yu;
304                    GetScrollPixelsPerUnit(&xu, &yu);
305                    Scroll(-1, y / yu);
306                }
307                cur.clear();
308                wxYield();
309                break;
310            }
311            case '<':
312                cur += wxT("&lt;");
313                break;
314            case '>':
315                cur += wxT("&gt;");
316                break;
317            case '&':
318                cur += wxT("&amp;");
319                break;
320            default:
321                if (ch >= 128) {
322                    cur += wxString::Format(wxT("&#%u;"), ch);
323                } else {
324                    cur += (char)ch;
325                }
326        }
327        ch = left;
328    }
329    int retval = pclose(cavern_out);
330    if (retval) {
331        if (retval == -1) {
332            wxString m = wxT("Problem running cavern: ");
333            m += wxString(strerror(errno), wxConvUTF8);
334            wxGetApp().ReportError(m);
335            return -2;
336        }
337        wxGetApp().ReportError(wxT("Failed to process survey data - see log window for details"));
338        return -1;
339    }
340    return link_count;
341}
Note: See TracBrowser for help on using the repository browser.