externaleditor.c

   1 /*
   2  * Copyright (c) 2012 Elias Norberg <xyzzy@kudzu.se>
   3  * Copyright (c) 2012 Josh Rickmar <jrick@devio.us>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 #include <xombrero.h>
  19
  20 #if WEBKIT_CHECK_VERSION(1, 5, 0)
  21         /* we got the DOM API we need */
  22
  23 struct edit_src_cb_args {
  24                 WebKitWebFrame          *frame;
  25                 WebKitWebDataSource     *data_src;
  26 };
  27
  28 struct external_editor_args {
  29                 GPid            child_pid;
  30                 char            *path;
  31                 time_t          mtime;
  32                 struct tab      *tab;
  33                 int             (*callback)(const char *,gpointer);
  34                 gpointer        cb_data;
  35 };
  36
  37 int
  38 update_contents(struct external_editor_args *args)
  39 {
  40         struct stat             st;
  41         int                     fd = -1;
  42         int                     rv, nb;
  43         GString                 *contents = NULL;
  44         char                    buf[XT_EE_BUFSZ];
  45
  46         rv = stat(args->path, &st);
  47         if (rv == -1 && errno == ENOENT)
  48                 return (1);
  49         else if (rv == 0 && st.st_mtime > args->mtime) {
  50                 DPRINTF("File %s has been modified\n", args->path);
  51                 args->mtime = st.st_mtime;
  52
  53                 contents = g_string_sized_new(XT_EE_BUFSZ);
  54                 fd = open(args->path, O_RDONLY);
  55                 if (fd == -1) {
  56                         DPRINTF("open_external_editor_cb, open error, %s\n",
  57                             strerror(errno));
  58                         goto done;
  59                 }
  60
  61                 for (;;) {
  62                         nb = read(fd, buf, XT_EE_BUFSZ);
  63                         if (nb < 0) {
  64                                 g_string_free(contents, TRUE);
  65                                 show_oops(args->tab, strerror(errno));
  66                                 goto done;
  67                         }
  68
  69                         buf[nb] = '\0';
  70                         contents = g_string_append(contents, buf);
  71
  72                         if (nb < XT_EE_BUFSZ)
  73                                 break;
  74                 }
  75                 close(fd);
  76                 fd = -1;
  77
  78                 DPRINTF("external_editor_cb: contents updated\n");
  79                 if (args->callback)
  80                         args->callback(contents->str, args->cb_data);
  81
  82                 g_string_free(contents, TRUE);
  83
  84                 return (0);
  85         }
  86
  87 done:
  88         if (fd != -1)
  89                 close(fd);
  90         return (0);
  91 }
  92
  93 void
  94 external_editor_closed(GPid pid, gint status, gpointer data)
  95 {
  96         struct external_editor_args     *args;
  97         struct tab                      *t;
  98         int                             found_tab = 0;
  99
 100         args = (struct external_editor_args *)data;
 101
 102         TAILQ_FOREACH(t, &tabs, entry)
 103                 if (t == args->tab) {
 104                         found_tab = 1;
 105                         break;
 106                 }
 107
 108         /* Tab was deleted */
 109         if (!found_tab)
 110                 goto done;
 111
 112         /*
 113          * unfortunately we can't check the exit status in glib < 2.34,
 114          * otherwise a check and warning would be nice here
 115          */
 116         update_contents(args);
 117
 118 done:
 119         unlink(args->path);
 120         g_spawn_close_pid(pid);
 121 }
 122
 123 int
 124 open_external_editor_cb(gpointer data)
 125 {
 126         struct external_editor_args     *args;
 127         struct tab                      *t;
 128         int                             found_tab = 0;
 129
 130         args = (struct external_editor_args*)data;
 131
 132         /* Check if tab is still open */
 133         TAILQ_FOREACH(t, &tabs, entry)
 134                 if (t == args->tab) {
 135                         found_tab = 1;
 136                         break;
 137                 }
 138
 139         /* Tab was deleted */
 140         if (!found_tab)
 141                 goto done;
 142
 143         if (update_contents(args))
 144                 goto done;
 145
 146         return (1);
 147 done:
 148         /* cleanup and remove from event loop */
 149         g_free(args->path);
 150         g_free(args->cb_data);
 151         g_free(args);
 152
 153         return (0);
 154 }
 155
 156 int
 157 open_external_editor(struct tab *t, const char *contents,
 158     int (*callback)(const char *, gpointer), gpointer cb_data)
 159 {
 160         struct stat                     st;
 161         struct external_editor_args     *a;
 162         GPid                            pid;
 163         char                            *cmdstr;
 164         char                            filename[PATH_MAX];
 165         char                            **sv;
 166         int                             fd;
 167         int                             nb, rv;
 168         int                             cnt;
 169
 170         if (external_editor == NULL)
 171                 return (0);
 172
 173         snprintf(filename, sizeof filename, "%s" PS "xombreroXXXXXX", temp_dir);
 174
 175         /* Create a temporary file */
 176         fd = g_mkstemp(filename);
 177         if (fd == -1) {
 178                 show_oops(t, "Cannot create temporary file");
 179                 return (1);
 180         }
 181
 182         nb = 0;
 183         while (nb < strlen(contents)) {
 184                 if (strlen(contents) - nb > XT_EE_BUFSZ)
 185                         cnt = XT_EE_BUFSZ;
 186                 else
 187                         cnt = strlen(contents) - nb;
 188
 189                 rv = write(fd, contents+nb, cnt);
 190                 if (rv < 0) {
 191                         close(fd);
 192                         show_oops(t,strerror(errno));
 193                         return (1);
 194                 }
 195
 196                 nb += rv;
 197         }
 198
 199         rv = fstat(fd, &st);
 200         if (rv == -1) {
 201                 close(fd);
 202                 show_oops(t,"Cannot stat file: %s\n", strerror(errno));
 203                 return (1);
 204         }
 205         close(fd);
 206
 207         DPRINTF("edit_src: external_editor: %s\n", external_editor);
 208
 209         sv = g_strsplit(external_editor, "<file>", -1);
 210         cmdstr = g_strjoinv(filename, sv);
 211         g_strfreev(sv);
 212         sv = g_strsplit_set(cmdstr, " \t", -1);
 213         if (!g_spawn_async(NULL, sv, NULL,
 214             (G_SPAWN_SEARCH_PATH | G_SPAWN_DO_NOT_REAP_CHILD), NULL, NULL, &pid,
 215             NULL)) {
 216                 show_oops(t, "%s: could not spawn process");
 217                 g_strfreev(sv);
 218                 g_free(cmdstr);
 219                 return (1);
 220         }
 221
 222         g_strfreev(sv);
 223         g_free(cmdstr);
 224
 225         a = g_malloc(sizeof(struct external_editor_args));
 226         a->child_pid = pid;
 227         a->path = g_strdup(filename);
 228         a->tab = t;
 229         a->mtime = st.st_mtime;
 230         a->callback = callback;
 231         a->cb_data = cb_data;
 232
 233         /* Check every 100 ms if file has changed */
 234         g_timeout_add(100, (GSourceFunc)open_external_editor_cb,
 235             (gpointer)a);
 236
 237         /* Stop loop  child has terminated */
 238         g_child_watch_add(pid, external_editor_closed, (gpointer)a);
 239
 240         return (0);
 241 }
 242
 243 int
 244 edit_src_cb(const char *contents, gpointer data)
 245 {
 246         struct edit_src_cb_args *args;
 247
 248         args = (struct edit_src_cb_args *)data;
 249
 250         webkit_web_frame_load_string(args->frame, contents, NULL,
 251             webkit_web_data_source_get_encoding(args->data_src),
 252             webkit_web_frame_get_uri(args->frame));
 253         return (0);
 254 }
 255
 256 int
 257 edit_src(struct tab *t, struct karg *args)
 258 {
 259         WebKitWebFrame          *frame;
 260         WebKitWebDataSource     *ds;
 261         GString                 *contents;
 262         struct edit_src_cb_args *ext_args;
 263
 264         if (external_editor == NULL){
 265                 show_oops(t,"Setting external_editor not set");
 266                 return (1);
 267         }
 268
 269         frame = webkit_web_view_get_focused_frame(t->wv);
 270         ds = webkit_web_frame_get_data_source(frame);
 271         if (webkit_web_data_source_is_loading(ds)) {
 272                 show_oops(t,"Webpage is still loading.");
 273                 return (1);
 274         }
 275
 276         contents = webkit_web_data_source_get_data(ds);
 277         if (!contents)
 278                 show_oops(t,"No contents - opening empty file");
 279
 280         ext_args = g_malloc(sizeof(struct edit_src_cb_args));
 281         ext_args->frame = frame;
 282         ext_args->data_src = ds;
 283
 284         /* Check every 100 ms if file has changed */
 285         open_external_editor(t, contents->str, &edit_src_cb, ext_args);
 286         return (0);
 287 }
 288
 289 struct edit_element_cb_args {
 290         WebKitDOMElement        *active;
 291         struct tab              *tab;
 292 };
 293
 294 int
 295 edit_element_cb(const char *contents, gpointer data)
 296 {
 297         struct                          edit_element_cb_args *args;
 298         WebKitDOMHTMLTextAreaElement    *ta;
 299         WebKitDOMHTMLInputElement       *el;
 300
 301         args = (struct edit_element_cb_args*)data;
 302
 303         if (!args || !args->active)
 304                 return (0);
 305
 306         el = (WebKitDOMHTMLInputElement*)args->active;
 307         ta = (WebKitDOMHTMLTextAreaElement*)args->active;
 308
 309         if (WEBKIT_DOM_IS_HTML_INPUT_ELEMENT(el))
 310                 webkit_dom_html_input_element_set_value(el, contents);
 311         else if (WEBKIT_DOM_IS_HTML_TEXT_AREA_ELEMENT(ta))
 312                 webkit_dom_html_text_area_element_set_value(ta, contents);
 313
 314         return (0);
 315 }
 316
 317 int
 318 edit_element(struct tab *t, struct karg *a)
 319 {
 320         WebKitDOMHTMLDocument           *doc;
 321         WebKitDOMElement                *active_element;
 322         WebKitDOMHTMLTextAreaElement    *ta;
 323         WebKitDOMHTMLInputElement       *el;
 324         char                            *contents;
 325         struct edit_element_cb_args     *args;
 326
 327         if (external_editor == NULL){
 328                 show_oops(t,"Setting external_editor not set");
 329                 return (0);
 330         }
 331
 332         doc = (WebKitDOMHTMLDocument*)webkit_web_view_get_dom_document(t->wv);
 333         active_element = webkit_dom_html_document_get_active_element(doc);
 334         el = (WebKitDOMHTMLInputElement*)active_element;
 335         ta = (WebKitDOMHTMLTextAreaElement*)active_element;
 336
 337         if (doc == NULL || active_element == NULL ||
 338             (WEBKIT_DOM_IS_HTML_INPUT_ELEMENT(el) == 0 &&
 339             WEBKIT_DOM_IS_HTML_TEXT_AREA_ELEMENT(ta) == 0)) {
 340                 show_oops(t, "No active text element!");
 341                 return (1);
 342         }
 343
 344         contents = "";
 345         if (WEBKIT_DOM_IS_HTML_INPUT_ELEMENT(el))
 346                 contents = webkit_dom_html_input_element_get_value(el);
 347         else if (WEBKIT_DOM_IS_HTML_TEXT_AREA_ELEMENT(ta))
 348                 contents = webkit_dom_html_text_area_element_get_value(ta);
 349
 350         if ((args = g_malloc(sizeof(struct edit_element_cb_args))) == NULL)
 351                 return (1);
 352
 353         args->tab = t;
 354         args->active = active_element;
 355
 356         open_external_editor(t, contents, &edit_element_cb,  args);
 357
 358         return (0);
 359 }
 360
 361 #else /* Just to make things compile. */
 362
 363 int
 364 edit_element(struct tab *t, struct karg *a)
 365 {
 366         show_oops(t, "external editor feature requires webkit >= 1.5.0");
 367         return (1);
 368 }
 369
 370 int
 371 edit_src(struct tab *t, struct karg *args)
 372 {
 373         show_oops(t, "external editor feature requires webkit >= 1.5.0");
 374         return (1);
 375 }
 376
 377 #endif