Probably about 1/2 way through now ...
[cocanwiki.git] / scripts / page.ml
index f741e58..9e63c07 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.30 2004/10/10 16:31:52 rich Exp $
+ * $Id: page.ml,v 1.43 2006/03/27 18:09:46 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,6 +25,7 @@ open Cgi
 open Printf
 
 open ExtString
+open ExtList
 
 open Cocanwiki
 open Cocanwiki_template
@@ -34,7 +35,8 @@ open Cocanwiki_server_settings
 open Cocanwiki_links
 
 type fp_status = FPOK of int * string * string * Dbi.datetime * bool
-              | FPRedirect of string
+              | FPInternalRedirect of string
+              | FPExternalRedirect of string
               | FPNotFound
 
 (* Referer strings which help us decide if the user came from
@@ -51,36 +53,44 @@ let split_qs_re = Pcre.regexp "\\?"
 
 let xhtml_re = Pcre.regexp "<.*?>|[^<>]+"
 
-let run r (q : cgi) (dbh : Dbi.connection) hostid
-    ({ edit_anon = edit_anon;
-       view_anon = view_anon } as host)
+let run r (q : cgi) dbh 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, navigation
+                                       mailing_list, navigation
                                   from hosts where id = ?" in
-  sth#execute [`Int hostid];
-  let has_host_css, has_feedback_email, mailing_list, search_box, navigation =
+  sth#execute [Some hostid];
+  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; `Bool navigation ] ->
-         has_host_css, has_feedback_email, mailing_list, search_box,
-         navigation
+         `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
@@ -161,7 +171,7 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
                                    where ? ~ url_regexp
                                    order by ordering
                                    limit 1" in
-    sth#execute [`String url];
+    sth#execute [Some url];
 
     try
       let name = sth#fetch1string () in
@@ -174,38 +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" (Int32.to_string pageid);
+          th#set "old_version" (Int32.to_string 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. *)
@@ -216,23 +244,23 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
            let sth = dbh#prepare_cached
                        "select ordering, sectionname, content, divname
                            from contents where pageid = ? order by ordering" in
-           sth#execute [`Int pageid];
+           sth#execute [Some pageid];
 
            sth#map
-             (function [`Int ordering;
-                        (`Null | `String _) as sectionname;
-                        `String content;
-                        (`Null | `String _) as divname] ->
+             (function [Some ordering;
+                        (None | Some _) as sectionname;
+                        Some content;
+                        (None | Some _) as divname] ->
                 let divname, has_divname =
                   match divname with
-                      `Null -> "", false
-                    | `String divname -> divname, true in
+                      None -> "", false
+                    | Some divname -> divname, true in
                 let sectionname, has_sectionname =
                   match sectionname with
-                      `Null -> "", false
-                    | `String sectionname -> sectionname, true in
+                      None -> "", false
+                    | Some sectionname -> sectionname, true in
                 let linkname = linkname_of_sectionname sectionname in
-                [ "ordering", Template.VarString (string_of_int ordering);
+                [ "ordering", Template.VarString (Int32.to_string ordering);
                   "has_sectionname",
                     Template.VarConditional has_sectionname;
                   "sectionname", Template.VarString sectionname;
@@ -262,35 +290,27 @@ 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, _, _) ->
+       | 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'];
+           sth#execute [Some hostid; Some userid; Some 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 ()
+           sth#execute [Some hostid; Some userid; Some page'];
+           PGOCaml.commit dbh
        | _ -> ()
     );
 
@@ -300,11 +320,12 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
 
       (* 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, _, _) ->
+         | User (userid, _, _, _) ->
              (* Recently visited URLs, but don't repeat any from the 'what
               * links here' section, and don't link to self.
               *)
@@ -320,11 +341,11 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
                        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
+             let args = List.map (fun s -> Some s) not_urls in
              sth#execute
-               ([`Int hostid; `Int userid] @ args @ [`Int limit]);
+               ([Some hostid; Some userid] @ args @ [Some limit]);
              sth#map
-               (function [`String url; `String title; _] ->
+               (function [Some url; Some title; _] ->
                   url, title
                   | _ -> assert false)
          | _ -> [] in
@@ -339,6 +360,11 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
       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
@@ -353,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. *)
@@ -376,14 +401,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
@@ -394,44 +413,43 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
    * (2) Page is a redirect (fetches the name of the redirect page).
    * (3) Page not found in database, could be template or 404 error.
    *)
-  (* XXX Should do a case-insensitive matching of URLs, and if the URL differs
-   * in case only should redirect to the lowercase version.
-   *)
   let fetch_page page version allow_redirect =
     match version with
       | None ->
          if allow_redirect then (
            let sth =
              dbh#prepare_cached
-               "select redirect, id, title, description, last_modified_date,
-                        css is not null
-                   from pages where hostid = ? and url = ?" in
-           sth#execute [`Int hostid; `String page];
+               "select url, redirect, id, title, description,
+                        last_modified_date, css is not null
+                   from pages where hostid = ? and lower (url) = lower (?)" in
+           sth#execute [Some hostid; Some page];
            (try
               (match sth#fetch1 () with
-                 | [ `Null; `Int id; `String title; `String description;
-                     `Timestamp last_modified_date; `Bool has_page_css ] ->
-                     FPOK (id, title, description, last_modified_date,
-                           has_page_css)
-                 | `String redirect :: _ ->
-                     FPRedirect redirect
-                 | _ -> assert false)
+               | Some page' :: _ when page <> page' -> (* different case *)
+                   FPExternalRedirect page'
+               | [ _; None; Some id; Some title; Some description;
+                   `Timestamp last_modified_date; `Bool has_page_css ] ->
+                   FPOK (id, title, description, last_modified_date,
+                         has_page_css)
+               | _ :: Some redirect :: _ ->
+                   FPInternalRedirect redirect
+               | xs -> failwith (Dbi.sdebug xs))
             with
-                Not_found -> FPNotFound)
+              Not_found -> FPNotFound)
          ) else (* redirects not allowed ... *) (
            let sth =
              dbh#prepare_cached
                "select id, title, description, last_modified_date,
                         css is not null
                    from pages where hostid = ? and url = ?" in
-           sth#execute [`Int hostid; `String page];
+           sth#execute [Some hostid; Some page];
            (try
               (match sth#fetch1 () with
-                 | [ `Int id; `String title; `String description;
-                     `Timestamp last_modified_date; `Bool has_page_css ] ->
-                     FPOK (id, title, description, last_modified_date,
-                           has_page_css)
-                 | _ -> assert false)
+               | [ Some id; Some title; Some description;
+                   `Timestamp last_modified_date; `Bool has_page_css ] ->
+                   FPOK (id, title, description, last_modified_date,
+                         has_page_css)
+               | xs -> failwith (Dbi.sdebug xs))
             with
                 Not_found -> FPNotFound)
          )
@@ -443,15 +461,15 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
                    from pages
                   where hostid = ? and id = ? and
                         (url = ? or url_deleted = ?)" in
-           sth#execute [`Int hostid; `Int version;
-                        `String page; `String page];
+           sth#execute [Some hostid; Some version;
+                        Some page; Some page];
            (try
               (match sth#fetch1 () with
-                 | [ `Int id; `String title; `String description;
-                     `Timestamp last_modified_date; `Bool has_page_css ] ->
-                     FPOK (id, title, description, last_modified_date,
-                           has_page_css)
-                 | _ -> assert false)
+               | [ Some id; Some title; Some description;
+                   `Timestamp last_modified_date; `Bool has_page_css ] ->
+                   FPOK (id, title, description, last_modified_date,
+                         has_page_css)
+               | xs -> failwith (Dbi.sdebug xs))
             with
                 Not_found -> FPNotFound)
   in
@@ -461,15 +479,16 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
   let allow_redirect, version =
     if can_edit then (
       not (q#param_true "no_redirect"),
-      try Some (int_of_string (q#param "version")) with Not_found -> None
+      try Some (Int32.of_string (q#param "version")) with Not_found -> None
     ) else
       (true, None) in
 
   let rec loop page' i =
     if i > max_redirect then (
       error ~title:"Too many redirections" ~back_button:true
-        q ("Too many redirects between pages.  This may happen because " ^
-          "of a cycle of redirections.");
+        dbh hostid q
+       ("Too many redirects between pages.  This may happen because " ^
+        "of a cycle of redirections.");
       return ()
     ) else
       match fetch_page page' version allow_redirect with
@@ -479,8 +498,14 @@ let run r (q : cgi) (dbh : Dbi.connection) hostid
            make_page title (Some description) (Some pageid)
              (printable_date last_modified_date) has_page_css
              version page page' extension
-       | FPRedirect page' ->
+       | FPInternalRedirect page' ->
            loop page' (i+1)
+       | FPExternalRedirect page' ->
+           (* This normally happens when a user has request an uppercase
+            * page name.  We redirect to the true (lowercase) version.
+            *)
+           q#redirect ("http://" ^ host.hostname ^ "/" ^ page');
+           return ()
        | FPNotFound ->
            (* Might be a templated page with no content in it. *)
            let extension = get_extension page' in