Split the 'page' template into two halves to enable pipelining. The
[cocanwiki.git] / scripts / page.ml
index 7e2f02d..b82c7cc 100644 (file)
@@ -1,7 +1,7 @@
 (* COCANWIKI - a wiki written in Objective CAML.
  * Written by Richard W.M. Jones <rich@merjis.com>.
  * Copyright (C) 2004 Merjis Ltd.
- * $Id: page.ml,v 1.26 2004/10/07 16:54:24 rich Exp $
+ * $Id: page.ml,v 1.39 2004/11/05 11:35:53 rich Exp $
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -25,15 +25,14 @@ open Cgi
 open Printf
 
 open ExtString
+open ExtList
 
 open Cocanwiki
 open Cocanwiki_template
 open Cocanwiki_ok
 open Cocanwiki_date
 open Cocanwiki_server_settings
-
-(* Maximum level of redirection. *)
-let max_redirect = 4
+open Cocanwiki_links
 
 type fp_status = FPOK of int * string * string * Dbi.datetime * bool
               | FPRedirect of string
@@ -57,31 +56,41 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
     ({ edit_anon = edit_anon;
        view_anon = view_anon } as host)
     user =
-  let template_page = get_template dbh hostid "page.html" in
-  let template_404  = get_template dbh hostid "page_404.html" in
-
   let page = q#param "page" in
   let page = if page = "" then "index" else page in
 
+  (* The main "page" template is split in two to improve the speed of
+   * delivery of the page.  The very first part ("page_header.html")
+   * contains the page <head>, crucially including all the links to the
+   * stylesheets.  We send this first and flush it out to the client so
+   * that the client can begin requesting stylesheets, background images
+   * and so on.  After this we compose the main page ("page.html") and
+   * send it out second.
+   *)
+
+  let template_page_header =
+    get_template ~page dbh hostid "page_header.html" in
+  let template_page = get_template ~page dbh hostid "page.html" in
+
+  (* This is the simpler template for 404 pages. *)
+  let template_404  = get_template dbh hostid "page_404.html" in
+
   (* Host-specific fields. *)
   let sth = dbh#prepare_cached "select css is not null,
                                        feedback_email is not null,
-                                       mailing_list, search_box
+                                       mailing_list, navigation
                                   from hosts where id = ?" in
   sth#execute [`Int hostid];
-  let has_host_css, has_feedback_email, mailing_list, search_box =
+  let has_host_css, has_feedback_email, mailing_list, navigation =
     match sth#fetch1 () with
       | [ `Bool has_host_css; `Bool has_feedback_email; `Bool mailing_list;
-         `Bool search_box ] ->
-         has_host_css, has_feedback_email, mailing_list, search_box
+         `Bool navigation ] ->
+         has_host_css, has_feedback_email, mailing_list, navigation
       | _ -> assert false in
 
-  (* Can the user edit?  Manage users?  etc. *)
+  (* User permissions. *)
   let can_edit = can_edit host user in
   let can_manage_users = can_manage_users host user in
-  let can_manage_contacts = can_manage_contacts host user in
-  let can_manage_site = can_manage_site host user in
-  let can_edit_global_css = can_edit_global_css host user in
 
   (* Do we have a stats page set up? *)
   let has_stats = server_settings_stats_page dbh <> None in
@@ -175,37 +184,56 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
   let make_page title description pageid last_modified_date has_page_css
       version page page' extension =
     let t = template_page in
+    let th = template_page_header in
     t#set "title" title;
+    th#set "title" title;
     t#set "last_modified_date" last_modified_date;
 
     (match description with
-        None -> t#conditional "has_description" false
+        None -> th#conditional "has_description" false
        | Some description ->
-          t#conditional "has_description" true;
-          t#set "description" description);
+          th#conditional "has_description" true;
+          th#set "description" description);
 
     if page <> page' then (* redirection *) (
       t#set "page" page';
+      th#set "page" page';
       t#set "original_page" page; (* XXX title - get it from database *)
       t#conditional "redirected" true
     ) else (
       t#set "page" page;
+      th#set "page" page;
       t#conditional "redirected" false
     );
 
-    t#conditional "has_host_css" has_host_css;
-    t#conditional "has_page_css" has_page_css;
+    th#conditional "has_host_css" has_host_css;
+    th#conditional "has_page_css" has_page_css;
+
+    (* Are we showing an old version of the page?  If so, warn. *)
+    (match version with
+        None ->
+          t#conditional "is_old_version" false;
+          th#conditional "is_old_version" false
+       | Some pageid ->
+          t#conditional "is_old_version" true;
+          th#conditional "is_old_version" true;
+          t#set "old_version" (string_of_int pageid);
+          th#set "old_version" (string_of_int pageid));
+
+    (* At this point, we can print out the header and flush it back to
+     * the user, allowing the browser to start fetching stylesheets
+     * and background images while we compose the page.
+     *)
+    q#header ();
+    print_string r th#to_string;
+    Request.rflush r;
 
     t#conditional "has_feedback_email" has_feedback_email;
     t#conditional "mailing_list" mailing_list;
-    t#conditional "search_box" search_box;
+    t#conditional "navigation" navigation;
 
     t#conditional "can_edit" can_edit;
     t#conditional "can_manage_users" can_manage_users;
-    t#conditional "can_manage_contacts" can_manage_contacts;
-    t#conditional "can_manage_site" can_manage_site;
-    t#conditional "can_edit_global_css" can_edit_global_css;
-
     t#conditional "has_stats" has_stats;
 
     (* Pull out the sections in this page. *)
@@ -262,22 +290,83 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
 
     t#table "sections" sections;
 
-    (* Are we showing an old version of the page?  If so, warn. *)
-    (match version with
-        None ->
-          t#conditional "is_old_version" false
-       | Some pageid ->
-          t#conditional "is_old_version" true;
-          t#set "old_version" (string_of_int pageid));
-
     (* Login status. *)
     (match user with
         Anonymous ->
           t#conditional "user_logged_in" false
-       | User (_, username, _) ->
+       | User (_, username, _, _) ->
           t#conditional "user_logged_in" true;
           t#set "username" username);
 
+    (* If logged in, we want to update the recently_visited table. *)
+    if pageid <> None then (
+      match user with
+       | User (userid, _, _, _) ->
+           let sth = dbh#prepare_cached "delete from recently_visited
+                                           where hostid = ? and userid = ?
+                                             and url = ?" in
+           sth#execute [`Int hostid; `Int userid; `String page'];
+           let sth = dbh#prepare_cached
+                       "insert into recently_visited (hostid, userid, url)
+                         values (?, ?, ?)" in
+           sth#execute [`Int hostid; `Int userid; `String page'];
+           dbh#commit ()
+       | _ -> ()
+    );
+
+    (* Navigation links. *)
+    if navigation then (
+      let max_links = 18 in            (* Show no more links than this. *)
+
+      (* What links here. *)
+      let wlh = what_links_here dbh hostid page' in
+      let wlh = List.take max_links wlh in
+      let wlh_urls = List.map fst wlh in (* Just the URLs ... *)
+
+      let rv =
+       match user with
+         | User (userid, _, _, _) ->
+             (* Recently visited URLs, but don't repeat any from the 'what
+              * links here' section, and don't link to self.
+              *)
+             let not_urls = page' :: wlh_urls in
+             let limit = max_links - List.length wlh_urls in
+             let qs = Dbi.placeholders (List.length not_urls) in
+             let sth =
+               dbh#prepare_cached
+                 ("select rv.url, p.title, rv.visit_time
+                      from recently_visited rv, pages p
+                     where rv.hostid = ? and rv.userid = ?
+                       and rv.url not in " ^ qs ^ "
+                       and rv.hostid = p.hostid and rv.url = p.url
+                     order by 3 desc
+                     limit ?") in
+             let args = List.map (fun s -> `String s) not_urls in
+             sth#execute
+               ([`Int hostid; `Int userid] @ args @ [`Int limit]);
+             sth#map
+               (function [`String url; `String title; _] ->
+                  url, title
+                  | _ -> assert false)
+         | _ -> [] in
+
+      (* Links to page. *)
+      let f (page, title) = [ "page", Template.VarString page;
+                             "title", Template.VarString title ] in
+      let table = List.map f wlh in
+      t#table "what_links_here" table;
+      t#conditional "has_what_links_here" (wlh <> []);
+
+      let table = List.map f rv in
+      t#table "recently_visited" table;
+      t#conditional "has_recently_visited" (rv <> []);
+
+      (* If both lists are empty (ie. an empty navigation box would
+       * appear), then disable navigation altogether.
+       *)
+      if wlh = [] && rv = [] then t#conditional "navigation" false
+    );
+
     (* If we are coming from a search engine then we want to highlight
      * search terms throughout the whole page ...
      *)
@@ -290,12 +379,11 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
       let xhtml = highlight_search_terms xhtml search_terms "search_term" in
 
       (* Deliver the page. *)
-      q#header ();
-      print_string r xhtml
+      ignore (print_string r xhtml)
     with
        Not_found ->
          (* No referer / no search terms / not a search engine referer. *)
-         q#template t
+         ignore (print_string r t#to_string)
   in
 
   (* This code generates 404 pages. *)
@@ -314,13 +402,8 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
     t#set "search_terms" search_terms;
 
     t#conditional "has_host_css" has_host_css;
-
     t#conditional "can_edit" can_edit;
     t#conditional "can_manage_users" can_manage_users;
-    t#conditional "can_manage_contacts" can_manage_contacts;
-    t#conditional "can_manage_site" can_manage_site;
-    t#conditional "can_edit_global_css" can_edit_global_css;
-
     t#conditional "has_stats" has_stats;
 
     q#template t