src/session/session.c

   1 /** Sessions managment - you'll find things here which you wouldn't expect
   2  * @file */
   3
   4 #ifdef HAVE_CONFIG_H
   5 #include "config.h"
   6 #endif
   7
   8 #include <stdio.h>
   9 #include <stdlib.h>
  10 #include <string.h>
  11
  12 #include "elinks.h"
  13
  14 #include "bfu/dialog.h"
  15 #include "bookmarks/bookmarks.h"
  16 #include "cache/cache.h"
  17 #include "config/home.h"
  18 #include "config/options.h"
  19 #include "dialogs/menu.h"
  20 #include "dialogs/status.h"
  21 #include "document/document.h"
  22 #include "document/html/frames.h"
  23 #include "document/refresh.h"
  24 #include "document/renderer.h"
  25 #include "document/view.h"
  26 #include "globhist/globhist.h"
  27 #include "intl/gettext/libintl.h"
  28 #include "main/event.h"
  29 #include "main/object.h"
  30 #include "main/timer.h"
  31 #include "network/connection.h"
  32 #include "network/state.h"
  33 #include "osdep/newwin.h"
  34 #include "protocol/protocol.h"
  35 #include "protocol/uri.h"
  36 #include "session/download.h"
  37 #include "session/history.h"
  38 #include "session/location.h"
  39 #include "session/session.h"
  40 #include "session/task.h"
  41 #include "terminal/tab.h"
  42 #include "terminal/terminal.h"
  43 #include "terminal/window.h"
  44 #include "util/conv.h"
  45 #include "util/error.h"
  46 #include "util/memlist.h"
  47 #include "util/memory.h"
  48 #include "util/string.h"
  49 #include "util/time.h"
  50 #include "viewer/text/draw.h"
  51 #include "viewer/text/form.h"
  52 #include "viewer/text/link.h"
  53 #include "viewer/text/view.h"
  54
  55
  56 struct file_to_load {
  57         LIST_HEAD(struct file_to_load);
  58
  59         struct session *ses;
  60         unsigned int req_sent:1;
  61         int pri;
  62         struct cache_entry *cached;
  63         unsigned char *target_frame;
  64         struct uri *uri;
  65         struct download download;
  66 };
  67
  68 /** This structure and related functions are used to maintain information
  69  * for instances opened in new windows. We store all related session info like
  70  * URI and base session to clone from so that when the new instance connects
  71  * we can look up this information. In case of failure the session information
  72  * has a timeout */
  73 struct session_info {
  74         LIST_HEAD(struct session_info);
  75
  76         int id;
  77         timer_id_T timer;
  78         struct session *ses;
  79         struct uri *uri;
  80         struct uri *referrer;
  81         enum task_type task;
  82         enum cache_mode cache_mode;
  83 };
  84
  85 #define file_to_load_is_active(ftl) ((ftl)->req_sent && is_in_progress_state((ftl)->download.state))
  86
  87
  88 INIT_LIST_OF(struct session, sessions);
  89
  90 enum remote_session_flags remote_session_flags;
  91
  92
  93 static struct file_to_load *request_additional_file(struct session *,
  94                                                     unsigned char *,
  95                                                     struct uri *, int);
  96
  97 static window_handler_T tabwin_func;
  98
  99
 100 static INIT_LIST_OF(struct session_info, session_info);
 101 static int session_info_id = 1;
 102
 103 static struct session_info *
 104 get_session_info(int id)
 105 {
 106         struct session_info *info;
 107
 108         foreach (info, session_info) {
 109                 struct session *ses;
 110
 111                 if (info->id != id) continue;
 112
 113                 /* Make sure the info->ses session is still with us. */
 114                 foreach (ses, sessions)
 115                         if (ses == info->ses)
 116                                 return info;
 117
 118                 info->ses = NULL;
 119                 return info;
 120         }
 121
 122         return NULL;
 123 }
 124
 125 static void
 126 done_session_info(struct session_info *info)
 127 {
 128         del_from_list(info);
 129         kill_timer(&info->timer);
 130
 131         if (info->uri) done_uri(info->uri);
 132         if (info->referrer) done_uri(info->referrer);
 133         mem_free(info);
 134 }
 135
 136 void
 137 done_saved_session_info(void)
 138 {
 139         while (!list_empty(session_info))
 140                 done_session_info(session_info.next);
 141 }
 142
 143 /** Timer callback for session_info.timer.  As explained in install_timer(),
 144  * this function must erase the expired timer ID from all variables.  */
 145 static void
 146 session_info_timeout(int id)
 147 {
 148         struct session_info *info = get_session_info(id);
 149
 150         if (!info) return;
 151         info->timer = TIMER_ID_UNDEF;
 152         /* The expired timer ID has now been erased.  */
 153         done_session_info(info);
 154 }
 155
 156 int
 157 add_session_info(struct session *ses, struct uri *uri, struct uri *referrer,
 158                  enum cache_mode cache_mode, enum task_type task)
 159 {
 160         struct session_info *info = mem_calloc(1, sizeof(*info));
 161
 162         if (!info) return -1;
 163
 164         info->id = session_info_id++;
 165         /* I don't know what a reasonable start up time for a new instance is
 166          * but it won't hurt to have a few seconds atleast. --jonas */
 167         install_timer(&info->timer, (milliseconds_T) 10000,
 168                       (void (*)(void *)) session_info_timeout,
 169                       (void *) (long) info->id);
 170
 171         info->ses = ses;
 172         info->task = task;
 173         info->cache_mode = cache_mode;
 174
 175         if (uri) info->uri = get_uri_reference(uri);
 176         if (referrer) info->referrer = get_uri_reference(referrer);
 177
 178         add_to_list(session_info, info);
 179
 180         return info->id;
 181 }
 182
 183 static struct session *
 184 init_saved_session(struct terminal *term, int id)
 185 {
 186         struct session_info *info = get_session_info(id);
 187         struct session *ses;
 188
 189         if (!info) return NULL;
 190
 191         ses = init_session(info->ses, term, info->uri, 0);
 192
 193         if (!ses) {
 194                 done_session_info(info);
 195                 return ses;
 196         }
 197
 198         /* Only do the ses_goto()-thing for target=_blank. */
 199         if (info->uri && info->task != TASK_NONE) {
 200                 /* The init_session() call would have started the download but
 201                  * not with the requested cache mode etc. so interrupt that
 202                  * download . */
 203                 abort_loading(ses, 1);
 204
 205                 ses->reloadlevel = info->cache_mode;
 206                 set_session_referrer(ses, info->referrer);
 207                 ses_goto(ses, info->uri, NULL, NULL, info->cache_mode,
 208                          info->task, 0);
 209         }
 210
 211         done_session_info(info);
 212
 213         return ses;
 214 }
 215
 216 static struct session *
 217 get_master_session(void)
 218 {
 219         struct session *ses;
 220
 221         foreach (ses, sessions)
 222                 if (ses->tab->term->master) {
 223                         struct window *current_tab = get_current_tab(ses->tab->term);
 224
 225                         return current_tab ? current_tab->data : NULL;
 226                 }
 227
 228         return NULL;
 229 }
 230
 231 /** @relates session */
 232 struct download *
 233 get_current_download(struct session *ses)
 234 {
 235         struct download *download = NULL;
 236
 237         if (!ses) return NULL;
 238
 239         if (ses->task.type)
 240                 download = &ses->loading;
 241         else if (have_location(ses))
 242                 download = &cur_loc(ses)->download;
 243
 244         if (download && download->state == S_OK) {
 245                 struct file_to_load *ftl;
 246
 247                 foreach (ftl, ses->more_files)
 248                         if (file_to_load_is_active(ftl))
 249                                 return &ftl->download;
 250         }
 251
 252         /* Note that @download isn't necessarily NULL here,
 253          * if @ses->more_files is empty. -- Miciah */
 254         return download;
 255 }
 256
 257 void
 258 print_error_dialog(struct session *ses, enum connection_state state,
 259                    struct uri *uri, enum connection_priority priority)
 260 {
 261         struct string msg;
 262         unsigned char *uristring;
 263
 264         /* Don't show error dialogs for missing CSS stylesheets */
 265         if (priority == PRI_CSS
 266             || !init_string(&msg))
 267                 return;
 268
 269         uristring = uri ? get_uri_string(uri, URI_PUBLIC) : NULL;
 270         if (uristring) {
 271 #ifdef CONFIG_UTF8
 272                 if (ses->tab->term->utf8_cp)
 273                         decode_uri(uristring);
 274                 else
 275 #endif /* CONFIG_UTF8 */
 276                         decode_uri_for_display(uristring);
 277                 add_format_to_string(&msg,
 278                         _("Unable to retrieve %s", ses->tab->term),
 279                         uristring);
 280                 mem_free(uristring);
 281                 add_to_string(&msg, ":\n\n");
 282         }
 283
 284         add_to_string(&msg, get_state_message(state, ses->tab->term));
 285
 286         info_box(ses->tab->term, MSGBOX_FREE_TEXT,
 287                  N_("Error"), ALIGN_CENTER,
 288                  msg.source);
 289
 290         /* TODO: retry */
 291 }
 292
 293 static void
 294 abort_files_load(struct session *ses, int interrupt)
 295 {
 296         while (1) {
 297                 struct file_to_load *ftl;
 298                 int more = 0;
 299
 300                 foreach (ftl, ses->more_files) {
 301                         if (!file_to_load_is_active(ftl))
 302                                 continue;
 303
 304                         more = 1;
 305                         cancel_download(&ftl->download, interrupt);
 306                 }
 307
 308                 if (!more) break;
 309         };
 310 }
 311
 312 void
 313 free_files(struct session *ses)
 314 {
 315         struct file_to_load *ftl;
 316
 317         abort_files_load(ses, 0);
 318         foreach (ftl, ses->more_files) {
 319                 if (ftl->cached) object_unlock(ftl->cached);
 320                 if (ftl->uri) done_uri(ftl->uri);
 321                 mem_free_if(ftl->target_frame);
 322         }
 323         free_list(ses->more_files);
 324 }
 325
 326
 327
 328
 329 static void request_frameset(struct session *, struct frameset_desc *, int);
 330
 331 static void
 332 request_frame(struct session *ses, unsigned char *name,
 333               struct uri *uri, int depth)
 334 {
 335         struct location *loc = cur_loc(ses);
 336         struct frame *frame;
 337
 338         assertm(have_location(ses), "request_frame: no location");
 339         if_assert_failed return;
 340
 341         foreach (frame, loc->frames) {
 342                 struct document_view *doc_view;
 343
 344                 if (strcasecmp(frame->name, name))
 345                         continue;
 346
 347                 foreach (doc_view, ses->scrn_frames) {
 348                         if (doc_view->vs == &frame->vs && doc_view->document->frame_desc) {
 349                                 request_frameset(ses, doc_view->document->frame_desc, depth);
 350                                 return;
 351                         }
 352                 }
 353
 354                 request_additional_file(ses, name, frame->vs.uri, PRI_FRAME);
 355                 return;
 356         }
 357
 358         frame = mem_calloc(1, sizeof(*frame));
 359         if (!frame) return;
 360
 361         frame->name = stracpy(name);
 362         if (!frame->name) {
 363                 mem_free(frame);
 364                 return;
 365         }
 366
 367         init_vs(&frame->vs, uri, -1);
 368
 369         add_to_list(loc->frames, frame);
 370
 371         request_additional_file(ses, name, frame->vs.uri, PRI_FRAME);
 372 }
 373
 374 static void
 375 request_frameset(struct session *ses, struct frameset_desc *frameset_desc, int depth)
 376 {
 377         int i;
 378
 379         if (depth > HTML_MAX_FRAME_DEPTH) return;
 380
 381         depth++; /* Inheritation counter (recursion brake ;) */
 382
 383         for (i = 0; i < frameset_desc->n; i++) {
 384                 struct frame_desc *frame_desc = &frameset_desc->frame_desc[i];
 385
 386                 if (frame_desc->subframe) {
 387                         request_frameset(ses, frame_desc->subframe, depth);
 388                 } else if (frame_desc->name && frame_desc->uri) {
 389                         request_frame(ses, frame_desc->name,
 390                                       frame_desc->uri, depth);
 391                 }
 392         }
 393 }
 394
 395 #ifdef CONFIG_CSS
 396 static inline void
 397 load_css_imports(struct session *ses, struct document_view *doc_view)
 398 {
 399         struct document *document = doc_view->document;
 400         struct uri *uri;
 401         int index;
 402
 403         if (!document) return;
 404
 405         foreach_uri (uri, index, &document->css_imports) {
 406                 request_additional_file(ses, "", uri, PRI_CSS);
 407         }
 408 }
 409 #else
 410 #define load_css_imports(ses, doc_view)
 411 #endif
 412
 413 #ifdef CONFIG_ECMASCRIPT
 414 static inline void
 415 load_ecmascript_imports(struct session *ses, struct document_view *doc_view)
 416 {
 417         struct document *document = doc_view->document;
 418         struct uri *uri;
 419         int index;
 420
 421         if (!document) return;
 422
 423         foreach_uri (uri, index, &document->ecmascript_imports) {
 424                 request_additional_file(ses, "", uri, /* XXX */ PRI_CSS);
 425         }
 426 }
 427 #else
 428 #define load_ecmascript_imports(ses, doc_view)
 429 #endif
 430
 431 inline void
 432 load_frames(struct session *ses, struct document_view *doc_view)
 433 {
 434         struct document *document = doc_view->document;
 435
 436         if (!document || !document->frame_desc) return;
 437         request_frameset(ses, document->frame_desc, 0);
 438
 439         foreach (doc_view, ses->scrn_frames) {
 440                 load_css_imports(ses, doc_view);
 441                 load_ecmascript_imports(ses, doc_view);
 442         }
 443 }
 444
 445 /** Timer callback for session.display_timer.  As explained in install_timer(),
 446  * this function must erase the expired timer ID from all variables.  */
 447 void
 448 display_timer(struct session *ses)
 449 {
 450         timeval_T start, stop, duration;
 451         milliseconds_T t;
 452
 453         timeval_now(&start);
 454         draw_formatted(ses, 3);
 455         timeval_now(&stop);
 456         timeval_sub(&duration, &start, &stop);
 457
 458         t = mult_ms(timeval_to_milliseconds(&duration), DISPLAY_TIME);
 459         if (t < DISPLAY_TIME_MIN) t = DISPLAY_TIME_MIN;
 460         install_timer(&ses->display_timer, t,
 461                       (void (*)(void *)) display_timer,
 462                       ses);
 463         /* The expired timer ID has now been erased.  */
 464
 465         load_frames(ses, ses->doc_view);
 466         load_css_imports(ses, ses->doc_view);
 467         load_ecmascript_imports(ses, ses->doc_view);
 468         process_file_requests(ses);
 469 }
 470
 471
 472 struct questions_entry {
 473         LIST_HEAD(struct questions_entry);
 474
 475         void (*callback)(struct session *, void *);
 476         void *data;
 477 };
 478
 479 INIT_LIST_OF(struct questions_entry, questions_queue);
 480
 481
 482 void
 483 check_questions_queue(struct session *ses)
 484 {
 485         while (!list_empty(questions_queue)) {
 486                 struct questions_entry *q = questions_queue.next;
 487
 488                 q->callback(ses, q->data);
 489                 del_from_list(q);
 490                 mem_free(q);
 491         }
 492 }
 493
 494 void
 495 add_questions_entry(void (*callback)(struct session *, void *), void *data)
 496 {
 497         struct questions_entry *q = mem_alloc(sizeof(*q));
 498
 499         if (!q) return;
 500
 501         q->callback = callback;
 502         q->data     = data;
 503         add_to_list(questions_queue, q);
 504 }
 505
 506 #ifdef CONFIG_SCRIPTING
 507 static void
 508 maybe_pre_format_html(struct cache_entry *cached, struct session *ses)
 509 {
 510         struct fragment *fragment;
 511         static int pre_format_html_event = EVENT_NONE;
 512
 513         if (!cached || cached->preformatted)
 514                 return;
 515
 516         fragment = get_cache_fragment(cached);
 517         if (!fragment) return;
 518
 519         /* We cannot do anything if the data are fragmented. */
 520         if (!list_is_singleton(cached->frag)) return;
 521
 522         set_event_id(pre_format_html_event, "pre-format-html");
 523         trigger_event(pre_format_html_event, ses, cached);
 524
 525         /* XXX: Keep this after the trigger_event, because hooks might call
 526          * normalize_cache_entry()! */
 527         cached->preformatted = 1;
 528 }
 529 #endif
 530
 531 static int
 532 check_incomplete_redirects(struct cache_entry *cached)
 533 {
 534         assert(cached);
 535
 536         cached = follow_cached_redirects(cached);
 537         if (cached && !cached->redirect) {
 538                 /* XXX: This is not quite true, but does that difference
 539                  * matter here? */
 540                 return cached->incomplete;
 541         }
 542
 543         return 0;
 544 }
 545
 546 int
 547 session_is_loading(struct session *ses)
 548 {
 549         struct download *download = get_current_download(ses);
 550
 551         if (!download) return 0;
 552
 553         if (!is_in_result_state(download->state))
 554                 return 1;
 555
 556         /* The validness of download->cached (especially the download struct in
 557          * ses->loading) is hard to maintain so check before using it.
 558          * Related to bug 559. */
 559         if (download->cached
 560             && cache_entry_is_valid(download->cached)
 561             && check_incomplete_redirects(download->cached))
 562                 return 1;
 563
 564         return 0;
 565 }
 566
 567 void
 568 doc_loading_callback(struct download *download, struct session *ses)
 569 {
 570         int submit = 0;
 571
 572         if (is_in_result_state(download->state)) {
 573 #ifdef CONFIG_SCRIPTING
 574                 maybe_pre_format_html(download->cached, ses);
 575 #endif
 576                 kill_timer(&ses->display_timer);
 577
 578                 draw_formatted(ses, 1);
 579
 580                 if (get_cmd_opt_bool("auto-submit")) {
 581                         if (!list_empty(ses->doc_view->document->forms)) {
 582                                 get_cmd_opt_bool("auto-submit") = 0;
 583                                 submit = 1;
 584                         }
 585                 }
 586
 587                 load_frames(ses, ses->doc_view);
 588                 load_css_imports(ses, ses->doc_view);
 589                 load_ecmascript_imports(ses, ses->doc_view);
 590                 process_file_requests(ses);
 591
 592                 start_document_refreshes(ses);
 593
 594                 if (download->state != S_OK) {
 595                         print_error_dialog(ses, download->state,
 596                                            ses->doc_view->document->uri,
 597                                            download->pri);
 598                 }
 599
 600         } else if (is_in_transfering_state(download->state)
 601                    && ses->display_timer == TIMER_ID_UNDEF) {
 602                 display_timer(ses);
 603         }
 604
 605         check_questions_queue(ses);
 606         print_screen_status(ses);
 607
 608 #ifdef CONFIG_GLOBHIST
 609         if (download->pri != PRI_CSS) {
 610                 unsigned char *title = ses->doc_view->document->title;
 611                 struct uri *uri;
 612
 613                 if (download->conn)
 614                         uri = download->conn->proxied_uri;
 615                 else if (download->cached)
 616                         uri = download->cached->uri;
 617                 else
 618                         uri = NULL;
 619
 620                 if (uri)
 621                         add_global_history_item(struri(uri), title, time(NULL));
 622         }
 623 #endif
 624
 625         if (submit) auto_submit_form(ses);
 626 }
 627
 628 static void
 629 file_loading_callback(struct download *download, struct file_to_load *ftl)
 630 {
 631         if (ftl->download.cached && ftl->cached != ftl->download.cached) {
 632                 if (ftl->cached) object_unlock(ftl->cached);
 633                 ftl->cached = ftl->download.cached;
 634                 object_lock(ftl->cached);
 635         }
 636
 637         /* FIXME: We need to do content-type check here! However, we won't
 638          * handle properly the "Choose action" dialog now :(. */
 639         if (ftl->cached && !ftl->cached->redirect_get && download->pri != PRI_CSS) {
 640                 struct session *ses = ftl->ses;
 641                 struct uri *loading_uri = ses->loading_uri;
 642                 unsigned char *target_frame = ses->task.target.frame;
 643
 644                 ses->loading_uri = ftl->uri;
 645                 ses->task.target.frame = ftl->target_frame;
 646                 setup_download_handler(ses, &ftl->download, ftl->cached, 1);
 647                 ses->loading_uri = loading_uri;
 648                 ses->task.target.frame = target_frame;
 649         }
 650
 651         doc_loading_callback(download, ftl->ses);
 652 }
 653
 654 static struct file_to_load *
 655 request_additional_file(struct session *ses, unsigned char *name, struct uri *uri, int pri)
 656 {
 657         struct file_to_load *ftl;
 658
 659         if (uri->protocol == PROTOCOL_UNKNOWN) {
 660                 return NULL;
 661         }
 662
 663         /* XXX: We cannot run the external handler here, because
 664          * request_additional_file() is called many times for a single URL
 665          * (normally the foreach() right below catches them all). Anyway,
 666          * having <frame src="mailto:foo"> would be just weird, wouldn't it?
 667          * --pasky */
 668         if (get_protocol_external_handler(ses->tab->term, uri)) {
 669                 return NULL;
 670         }
 671
 672         foreach (ftl, ses->more_files) {
 673                 if (compare_uri(ftl->uri, uri, URI_BASE)) {
 674                         if (ftl->pri > pri) {
 675                                 ftl->pri = pri;
 676                                 move_download(&ftl->download, &ftl->download, pri);
 677                         }
 678                         return NULL;
 679                 }
 680         }
 681
 682         ftl = mem_calloc(1, sizeof(*ftl));
 683         if (!ftl) return NULL;
 684
 685         ftl->uri = get_uri_reference(uri);
 686         ftl->target_frame = stracpy(name);
 687         ftl->download.callback = (download_callback_T *) file_loading_callback;
 688         ftl->download.data = ftl;
 689         ftl->pri = pri;
 690         ftl->ses = ses;
 691
 692         add_to_list(ses->more_files, ftl);
 693
 694         return ftl;
 695 }
 696
 697 static void
 698 load_additional_file(struct file_to_load *ftl, enum cache_mode cache_mode)
 699 {
 700         struct document_view *doc_view = current_frame(ftl->ses);
 701         struct uri *referrer = doc_view && doc_view->document
 702                              ? doc_view->document->uri : NULL;
 703
 704         load_uri(ftl->uri, referrer, &ftl->download, ftl->pri, cache_mode, -1);
 705 }
 706
 707 void
 708 process_file_requests(struct session *ses)
 709 {
 710         if (ses->status.processing_file_requests) return;
 711         ses->status.processing_file_requests = 1;
 712
 713         while (1) {
 714                 struct file_to_load *ftl;
 715                 int more = 0;
 716
 717                 foreach (ftl, ses->more_files) {
 718                         if (ftl->req_sent)
 719                                 continue;
 720
 721                         ftl->req_sent = 1;
 722
 723                         load_additional_file(ftl, CACHE_MODE_NORMAL);
 724                         more = 1;
 725                 }
 726
 727                 if (!more) break;
 728         };
 729
 730         ses->status.processing_file_requests = 0;
 731 }
 732
 733
 734 static void
 735 dialog_goto_url_open(void *data)
 736 {
 737         dialog_goto_url((struct session *) data, NULL);
 738 }
 739
 740 /** @returns 0 if the first session was not properly initialized and
 741  * setup_session() should be called on the session as well. */
 742 static int
 743 setup_first_session(struct session *ses, struct uri *uri)
 744 {
 745         /* [gettext_accelerator_context(setup_first_session)] */
 746         struct terminal *term = ses->tab->term;
 747
 748         if (!*get_opt_str("protocol.http.user_agent", NULL)) {
 749                 info_box(term, 0,
 750                          N_("Warning"), ALIGN_CENTER,
 751                          N_("You have an empty string in protocol.http.user_agent - "
 752                          "this was a default value in the past, substituted by "
 753                          "default ELinks User-Agent string. However, currently "
 754                          "this means that NO User-Agent HEADER "
 755                          "WILL BE SENT AT ALL - if this is really what you want, "
 756                          "set its value to \" \", otherwise please delete the line "
 757                          "with this setting from your configuration file (if you "
 758                          "have no idea what I'm talking about, just do this), so "
 759                          "that the correct default setting will be used. Apologies for "
 760                          "any inconvience caused."));
 761         }
 762
 763         if (!get_opt_bool("config.saving_style_w", NULL)) {
 764                 struct option *opt = get_opt_rec(config_options, "config.saving_style_w");
 765                 opt->value.number = 1;
 766                 option_changed(ses, opt);
 767                 if (get_opt_int("config.saving_style", NULL) != 3) {
 768                         info_box(term, 0,
 769                                  N_("Warning"), ALIGN_CENTER,
 770                                  N_("You have option config.saving_style set to "
 771                                  "a de facto obsolete value. The configuration "
 772                                  "saving algorithms of ELinks were changed from "
 773                                  "the last time you upgraded ELinks. Now, only "
 774                                  "those options which you actually changed are "
 775                                  "saved to the configuration file, instead of "
 776                                  "all the options. This simplifies our "
 777                                  "situation greatly when we see that some option "
 778                                  "has an inappropriate default value or we need to "
 779                                  "change the semantics of some option in a subtle way. "
 780                                  "Thus, we recommend you change the value of "
 781                                  "config.saving_style option to 3 in order to get "
 782                                  "the \"right\" behaviour. Apologies for any "
 783                                  "inconvience caused."));
 784                 }
 785         }
 786
 787         if (first_use) {
 788                 /* Only open the goto URL dialog if no URI was passed on the
 789                  * command line. */
 790                 void *handler = uri ? NULL : dialog_goto_url_open;
 791
 792                 first_use = 0;
 793
 794                 msg_box(term, NULL, 0,
 795                         N_("Welcome"), ALIGN_CENTER,
 796                         N_("Welcome to ELinks!\n\n"
 797                         "Press ESC for menu. Documentation is available in "
 798                         "Help menu."),
 799                         ses, 1,
 800                         MSG_BOX_BUTTON(N_("~OK"), handler, B_ENTER | B_ESC));
 801
 802                 /* If there is no URI the goto dialog will pop up so there is
 803                  * no need to call setup_session(). */
 804                 if (!uri) return 1;
 805
 806 #ifdef CONFIG_BOOKMARKS
 807         } else if (!uri && get_opt_bool("ui.sessions.auto_restore", NULL)) {
 808                 unsigned char *folder;
 809
 810                 folder = get_opt_str("ui.sessions.auto_save_foldername", NULL);
 811                 open_bookmark_folder(ses, folder);
 812                 return 1;
 813 #endif
 814         }
 815
 816         /* If there's a URI to load we have to call */
 817         return 0;
 818 }
 819
 820 /** First load the current URI of the base session. In most cases it will just
 821  * be fetched from the cache so that the new tab will not appear ``empty' while
 822  * loading the real URI or showing the goto URL dialog. */
 823 static void
 824 setup_session(struct session *ses, struct uri *uri, struct session *base)
 825 {
 826         if (base && have_location(base)) {
 827                 struct location *loc = mem_calloc(1, sizeof(*loc));
 828
 829                 if (loc) {
 830                         copy_location(loc, cur_loc(base));
 831                         loc->download.data = ses;
 832                         loc->download.callback = (download_callback_T *) doc_loading_callback;
 833                         add_to_history(&ses->history, loc);
 834                         load_uri(loc->vs.uri, NULL, &loc->download, PRI_MAIN,
 835                                  CACHE_MODE_ALWAYS, -1);
 836                 }
 837         }
 838
 839         if (uri) {
 840                 goto_uri(ses, uri);
 841
 842         } else if (!goto_url_home(ses)) {
 843                 if (get_opt_bool("ui.startup_goto_dialog", NULL)) {
 844                         dialog_goto_url_open(ses);
 845                 }
 846         }
 847 }
 848
 849 /** @relates session  */
 850 struct session *
 851 init_session(struct session *base_session, struct terminal *term,
 852              struct uri *uri, int in_background)
 853 {
 854         struct session *ses = mem_calloc(1, sizeof(*ses));
 855
 856         if (!ses) return NULL;
 857
 858         ses->tab = init_tab(term, ses, tabwin_func);
 859         if (!ses->tab) {
 860                 mem_free(ses);
 861                 return NULL;
 862         }
 863
 864         ses->option = copy_option(config_options,
 865                                   CO_SHALLOW | CO_NO_LISTBOX_ITEM);
 866         create_history(&ses->history);
 867         init_list(ses->scrn_frames);
 868         init_list(ses->more_files);
 869         init_list(ses->type_queries);
 870         ses->task.type = TASK_NONE;
 871         ses->display_timer = TIMER_ID_UNDEF;
 872
 873 #ifdef CONFIG_LEDS
 874         init_led_panel(&ses->status.leds);
 875         ses->status.ssl_led = register_led(ses, 0);
 876         ses->status.insert_mode_led = register_led(ses, 1);
 877         ses->status.ecmascript_led = register_led(ses, 2);
 878         ses->status.popup_led = register_led(ses, 3);
 879
 880         ses->status.download_led = register_led(ses, 5);
 881 #endif
 882         ses->status.force_show_status_bar = -1;
 883         ses->status.force_show_title_bar = -1;
 884
 885         add_to_list(sessions, ses);
 886
 887         /* Update the status -- most importantly the info about whether to the
 888          * show the title, tab and status bar -- _before_ loading the URI so
 889          * the document cache is not filled with useless documents if the
 890          * content is already cached.
 891          *
 892          * For big document it also reduces memory usage quite a bit because
 893          * (atleast that is my interpretation --jonas) the old document will
 894          * have a chance to be released before rendering a new one. A few
 895          * numbers when opening a new tab while viewing debians package list
 896          * for unstable:
 897          *
 898          * 9307 jonas     15   0 34252  30m 5088 S  0.0 12.2   0:03.63 elinks-old
 899          * 9305 jonas     15   0 17060  13m 5088 S  0.0  5.5   0:02.07 elinks-new
 900          */
 901         update_status();
 902
 903         /* Check if the newly inserted session is the only in the list and do
 904          * the special setup for the first session, */
 905         if (!list_is_singleton(sessions) || !setup_first_session(ses, uri)) {
 906                 setup_session(ses, uri, base_session);
 907         }
 908
 909         if (!in_background)
 910                 switch_to_tab(term, get_tab_number(ses->tab), -1);
 911
 912         if (!term->main_menu) activate_bfu_technology(ses, -1);
 913         return ses;
 914 }
 915
 916 static void
 917 init_remote_session(struct session *ses, enum remote_session_flags *remote_ptr,
 918                     struct uri *uri)
 919 {
 920         enum remote_session_flags remote = *remote_ptr;
 921
 922         if (remote & SES_REMOTE_CURRENT_TAB) {
 923                 goto_uri(ses, uri);
 924                 /* Mask out the current tab flag */
 925                 *remote_ptr = remote & ~SES_REMOTE_CURRENT_TAB;
 926
 927                 /* Remote session was masked out. Open all following URIs in
 928                  * new tabs, */
 929                 if (!*remote_ptr)
 930                         *remote_ptr = SES_REMOTE_NEW_TAB;
 931
 932         } else if (remote & SES_REMOTE_NEW_TAB) {
 933                 /* FIXME: This is not perfect. Doing multiple -remote
 934                  * with no URLs will make the goto dialogs
 935                  * inaccessible. Maybe we should not support this kind
 936                  * of thing or make the window focus detecting code
 937                  * more intelligent. --jonas */
 938                 open_uri_in_new_tab(ses, uri, 0, 0);
 939
 940                 if (remote & SES_REMOTE_PROMPT_URL) {
 941                         dialog_goto_url_open(ses);
 942                 }
 943
 944         } else if (remote & SES_REMOTE_NEW_WINDOW) {
 945                 /* FIXME: It is quite rude because we just take the first
 946                  * possibility and should maybe make it possible to specify
 947                  * new-screen etc via -remote "openURL(..., new-*)" --jonas */
 948                 if (!can_open_in_new(ses->tab->term))
 949                         return;
 950
 951                 open_uri_in_new_window(ses, uri, NULL,
 952                                        ses->tab->term->environment,
 953                                        CACHE_MODE_NORMAL, TASK_NONE);
 954
 955         } else if (remote & SES_REMOTE_ADD_BOOKMARK) {
 956 #ifdef CONFIG_BOOKMARKS
 957                 if (!uri) return;
 958                 add_bookmark(NULL, 1, struri(uri), struri(uri));
 959 #endif
 960
 961         } else if (remote & SES_REMOTE_INFO_BOX) {
 962                 unsigned char *text;
 963
 964                 if (!uri) return;
 965
 966                 text = memacpy(uri->data, uri->datalen);
 967                 if (!text) return;
 968
 969                 info_box(ses->tab->term, MSGBOX_FREE_TEXT,
 970                          N_("Error"), ALIGN_CENTER,
 971                          text);
 972
 973         } else if (remote & SES_REMOTE_PROMPT_URL) {
 974                 dialog_goto_url_open(ses);
 975         }
 976 }
 977
 978
 979
 980 struct string *
 981 encode_session_info(struct string *info,
 982                     LIST_OF(struct string_list_item) *url_list)
 983 {
 984         struct string_list_item *url;
 985
 986         if (!init_string(info)) return NULL;
 987
 988         foreach (url, *url_list) {
 989                 struct string *str = &url->string;
 990
 991                 add_bytes_to_string(info, str->source, str->length + 1);
 992         }
 993
 994         return info;
 995 }
 996
 997 /** Older elinks versions (up to and including 0.9.1) sends no magic variable and if
 998  * this is detected we fallback to the old session info format. For this format
 999  * the magic member of terminal_info hold the length of the URI string. The
1000  * old format is handled by the default label in the switch.
1001  *
1002  * The new session info format supports extraction of multiple URIS from the
1003  * terminal_info data member. The magic variable controls how to interpret
1004  * the fields:
1005  *
1006  *    - INTERLINK_NORMAL_MAGIC means use the terminal_info session_info
1007  *      variable as an id for a saved session.
1008  *
1009  *    - INTERLINK_REMOTE_MAGIC means use the terminal_info session_info
1010  *      variable as the remote session flags. */
1011 int
1012 decode_session_info(struct terminal *term, struct terminal_info *info)
1013 {
1014         int len = info->length;
1015         struct session *base_session = NULL;
1016         enum remote_session_flags remote = 0;
1017         unsigned char *str;
1018
1019         switch (info->magic) {
1020         case INTERLINK_NORMAL_MAGIC:
1021                 /* Lookup if there are any saved sessions that should be
1022                  * resumed using the session_info as an id. The id is derived
1023                  * from the value of -base-session command line option in the
1024                  * connecting instance.
1025                  *
1026                  * At the moment it is only used when opening instances in new
1027                  * window to figure out how to initialize it when the new
1028                  * instance connects to the master.
1029                  *
1030                  * We don't need to handle it for the old format since new
1031                  * instances connecting this way will always be of the same
1032                  * origin as the master. */
1033                 if (init_saved_session(term, info->session_info))
1034                         return 1;
1035                 break;
1036
1037         case INTERLINK_REMOTE_MAGIC:
1038                 /* This could mean some fatal bug but I am unsure if we can
1039                  * actually assert it since people could pour all kinds of crap
1040                  * down the socket. */
1041                 if (!info->session_info) {
1042                         INTERNAL("Remote magic with no remote flags");
1043                         return 0;
1044                 }
1045
1046                 remote = info->session_info;
1047
1048                 /* If processing session info from a -remote instance we want
1049                  * to hook up with the master so we can handle request for
1050                  * stuff in current tab. */
1051                 base_session = get_master_session();
1052                 if (!base_session) return 0;
1053
1054                 break;
1055
1056         default:
1057                 /* The old format calculates the session_info and magic members
1058                  * as part of the data that should be decoded so we have to
1059                  * substract it to get the size of the actual URI data. */
1060                 len -= sizeof(info->session_info) + sizeof(info->magic);
1061
1062                 /* Extract URI containing @magic bytes */
1063                 if (info->magic <= 0 || info->magic > len)
1064                         len = 0;
1065                 else
1066                         len = info->magic;
1067         }
1068
1069         if (len <= 0) {
1070                 if (!remote)
1071                         return !!init_session(base_session, term, NULL, 0);
1072
1073                 /* Even though there are no URIs we still have to
1074                  * handle remote stuff. */
1075                 init_remote_session(base_session, &remote, NULL);
1076                 return 0;
1077         }
1078
1079         str = info->data;
1080
1081         /* Extract multiple (possible) NUL terminated URIs */
1082         while (len > 0) {
1083                 unsigned char *end = memchr(str, 0, len);
1084                 int urilength = end ? end - str : len;
1085                 struct uri *uri = NULL;
1086                 unsigned char *uristring = memacpy(str, urilength);
1087
1088                 if (uristring) {
1089                         uri = get_hooked_uri(uristring, base_session, term->cwd);
1090                         mem_free(uristring);
1091                 }
1092
1093                 len -= urilength + 1;
1094                 str += urilength + 1;
1095
1096                 if (remote) {
1097                         if (!uri) continue;
1098
1099                         init_remote_session(base_session, &remote, uri);
1100
1101                 } else {
1102                         int backgrounded = !list_empty(term->windows);
1103                         int bad_url = !uri;
1104                         struct session *ses;
1105
1106                         if (!uri)
1107                                 uri = get_uri("about:blank", 0);
1108
1109                         ses = init_session(base_session, term, uri, backgrounded);
1110                         if (!ses) {
1111                                 /* End loop if initialization fails */
1112                                 len = 0;
1113                         } else if (bad_url) {
1114                                 print_error_dialog(ses, S_BAD_URL, NULL, PRI_MAIN);
1115                         }
1116
1117                 }
1118
1119                 if (uri) done_uri(uri);
1120         }
1121
1122         /* If we only initialized remote sessions or didn't manage to add any
1123          * new tabs return zero so the terminal will be destroyed ASAP. */
1124         return remote ? 0 : !list_empty(term->windows);
1125 }
1126
1127
1128 void
1129 abort_loading(struct session *ses, int interrupt)
1130 {
1131         if (have_location(ses)) {
1132                 struct location *loc = cur_loc(ses);
1133
1134                 cancel_download(&loc->download, interrupt);
1135                 abort_files_load(ses, interrupt);
1136         }
1137         abort_preloading(ses, interrupt);
1138 }
1139
1140 static void
1141 destroy_session(struct session *ses)
1142 {
1143         struct document_view *doc_view;
1144
1145         assert(ses);
1146         if_assert_failed return;
1147
1148         destroy_downloads(ses);
1149         abort_loading(ses, 0);
1150         free_files(ses);
1151         if (ses->doc_view) {
1152                 detach_formatted(ses->doc_view);
1153                 mem_free(ses->doc_view);
1154         }
1155
1156         foreach (doc_view, ses->scrn_frames)
1157                 detach_formatted(doc_view);
1158
1159         free_list(ses->scrn_frames);
1160
1161         destroy_history(&ses->history);
1162         set_session_referrer(ses, NULL);
1163
1164         if (ses->loading_uri) done_uri(ses->loading_uri);
1165
1166         kill_timer(&ses->display_timer);
1167
1168         while (!list_empty(ses->type_queries))
1169                 done_type_query(ses->type_queries.next);
1170
1171         if (ses->download_uri) done_uri(ses->download_uri);
1172         mem_free_if(ses->search_word);
1173         mem_free_if(ses->last_search_word);
1174         mem_free_if(ses->status.last_title);
1175 #ifdef CONFIG_ECMASCRIPT
1176         mem_free_if(ses->status.window_status);
1177 #endif
1178         if (ses->option) {
1179                 delete_option(ses->option);
1180                 ses->option = NULL;
1181         }
1182         del_from_list(ses);
1183 }
1184
1185 void
1186 reload(struct session *ses, enum cache_mode cache_mode)
1187 {
1188         reload_frame(ses, NULL, cache_mode);
1189 }
1190
1191 void
1192 reload_frame(struct session *ses, unsigned char *name,
1193              enum cache_mode cache_mode)
1194 {
1195         abort_loading(ses, 0);
1196
1197         if (cache_mode == CACHE_MODE_INCREMENT) {
1198                 cache_mode = CACHE_MODE_NEVER;
1199                 if (ses->reloadlevel < CACHE_MODE_NEVER)
1200                         cache_mode = ++ses->reloadlevel;
1201         } else {
1202                 ses->reloadlevel = cache_mode;
1203         }
1204
1205         if (have_location(ses)) {
1206                 struct location *loc = cur_loc(ses);
1207                 struct file_to_load *ftl;
1208
1209 #ifdef CONFIG_ECMASCRIPT
1210                 loc->vs.ecmascript_fragile = 1;
1211 #endif
1212
1213                 /* FIXME: When reloading use loading_callback and set up a
1214                  * session task so that the reloading will work even when the
1215                  * reloaded document contains redirects. This is needed atleast
1216                  * when reloading HTTP auth document after the user has entered
1217                  * credentials. */
1218                 loc->download.data = ses;
1219                 loc->download.callback = (download_callback_T *) doc_loading_callback;
1220
1221                 ses->task.target.frame = name;
1222
1223                 load_uri(loc->vs.uri, ses->referrer, &loc->download, PRI_MAIN, cache_mode, -1);
1224
1225                 foreach (ftl, ses->more_files) {
1226                         if (file_to_load_is_active(ftl))
1227                                 continue;
1228
1229                         ftl->download.data = ftl;
1230                         ftl->download.callback = (download_callback_T *) file_loading_callback;
1231
1232                         load_additional_file(ftl, cache_mode);
1233                 }
1234         }
1235 }
1236
1237
1238 struct frame *
1239 ses_find_frame(struct session *ses, unsigned char *name)
1240 {
1241         struct location *loc = cur_loc(ses);
1242         struct frame *frame;
1243
1244         assertm(have_location(ses), "ses_request_frame: no location yet");
1245         if_assert_failed return NULL;
1246
1247         foreachback (frame, loc->frames)
1248                 if (!strcasecmp(frame->name, name))
1249                         return frame;
1250
1251         return NULL;
1252 }
1253
1254 void
1255 set_session_referrer(struct session *ses, struct uri *referrer)
1256 {
1257         if (ses->referrer) done_uri(ses->referrer);
1258         ses->referrer = referrer ? get_uri_reference(referrer) : NULL;
1259 }
1260
1261 static void
1262 tabwin_func(struct window *tab, struct term_event *ev)
1263 {
1264         struct session *ses = tab->data;
1265
1266         switch (ev->ev) {
1267                 case EVENT_ABORT:
1268                         if (ses) destroy_session(ses);
1269                         if (!list_empty(sessions)) update_status();
1270                         break;
1271                 case EVENT_INIT:
1272                 case EVENT_RESIZE:
1273                         tab->resize = 1;
1274                         /* fall-through */
1275                 case EVENT_REDRAW:
1276                         if (!ses || ses->tab != get_current_tab(ses->tab->term))
1277                                 break;
1278
1279                         draw_formatted(ses, tab->resize);
1280                         if (tab->resize) {
1281                                 load_frames(ses, ses->doc_view);
1282                                 process_file_requests(ses);
1283                                 tab->resize = 0;
1284                         }
1285                         print_screen_status(ses);
1286                         break;
1287                 case EVENT_KBD:
1288                 case EVENT_MOUSE:
1289                         if (!ses) break;
1290                         /* This check is related to bug 296 */
1291                         assert(ses->tab == get_current_tab(ses->tab->term));
1292                         send_event(ses, ev);
1293                         break;
1294         }
1295 }
1296
1297 /**
1298  * Gets the url being viewed by this session. Writes it into @a str.
1299  * A maximum of @a str_size bytes (including null) will be written.
1300  * @relates session
1301  */
1302 unsigned char *
1303 get_current_url(struct session *ses, unsigned char *str, size_t str_size)
1304 {
1305         struct uri *uri;
1306         int length;
1307
1308         assert(str && str_size > 0);
1309
1310         uri = have_location(ses) ? cur_loc(ses)->vs.uri : ses->loading_uri;
1311
1312         /* Not looking or loading anything */
1313         if (!uri) return NULL;
1314
1315         /* Ensure that the url size is not greater than str_size.
1316          * We can't just happily strncpy(str, here, str_size)
1317          * because we have to stop at POST_CHAR, not only at NULL. */
1318         length = int_min(get_real_uri_length(uri), str_size - 1);
1319
1320         return safe_strncpy(str, struri(uri), length + 1);
1321 }
1322
1323 /**
1324  * Gets the title of the page being viewed by this session. Writes it into
1325  * @a str.  A maximum of @a str_size bytes (including null) will be written.
1326  * @relates session
1327  */
1328 unsigned char *
1329 get_current_title(struct session *ses, unsigned char *str, size_t str_size)
1330 {
1331         struct document_view *doc_view = current_frame(ses);
1332
1333         assert(str && str_size > 0);
1334
1335         /* Ensure that the title is defined */
1336         /* TODO: Try globhist --jonas */
1337         if (doc_view && doc_view->document->title)
1338                 return safe_strncpy(str, doc_view->document->title, str_size);
1339
1340         return NULL;
1341 }
1342
1343 /**
1344  * Gets the url of the link currently selected. Writes it into @a str.
1345  * A maximum of @a str_size bytes (including null) will be written.
1346  * @relates session
1347  */
1348 unsigned char *
1349 get_current_link_url(struct session *ses, unsigned char *str, size_t str_size)
1350 {
1351         struct link *link = get_current_session_link(ses);
1352
1353         assert(str && str_size > 0);
1354
1355         if (!link) return NULL;
1356
1357         return safe_strncpy(str, link->where ? link->where : link->where_img, str_size);
1358 }
1359
1360 /** get_current_link_name: returns the name of the current link
1361  * (the text between @<A> and @</A>), @a str is a preallocated string,
1362  * @a str_size includes the null char.
1363  * @relates session */
1364 unsigned char *
1365 get_current_link_name(struct session *ses, unsigned char *str, size_t str_size)
1366 {
1367         struct link *link = get_current_session_link(ses);
1368         unsigned char *where, *name = NULL;
1369
1370         assert(str && str_size > 0);
1371
1372         if (!link) return NULL;
1373
1374         where = link->where ? link->where : link->where_img;
1375 #ifdef CONFIG_GLOBHIST
1376         {
1377                 struct global_history_item *item;
1378
1379                 item = get_global_history_item(where);
1380                 if (item) name = item->title;
1381         }
1382 #endif
1383         if (!name) name = get_link_name(link);
1384         if (!name) name = where;
1385
1386         return safe_strncpy(str, name, str_size);
1387 }
1388
1389 struct link *
1390 get_current_link_in_view(struct document_view *doc_view)
1391 {
1392         struct link *link = get_current_link(doc_view);
1393
1394         return link && !link_is_form(link) ? link : NULL;
1395 }
1396
1397 /** @relates session */
1398 struct link *
1399 get_current_session_link(struct session *ses)
1400 {
1401         return get_current_link_in_view(current_frame(ses));
1402 }
1403
1404 /** @relates session */
1405 int
1406 eat_kbd_repeat_count(struct session *ses)
1407 {
1408         int count = ses->kbdprefix.repeat_count;
1409
1410         ses->kbdprefix.repeat_count = 0;
1411
1412         /* Clear status bar when prefix is eaten (bug 930) */
1413         print_screen_status(ses);
1414         return count;
1415 }