scripts/page.ml

   1 (* COCANWIKI - a wiki written in Objective CAML.
   2  * Written by Richard W.M. Jones <rich@merjis.com>.
   3  * Copyright (C) 2004 Merjis Ltd.
   4  * $Id: page.ml,v 1.15 2004/09/20 15:34:36 rich Exp $
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; see the file COPYING.  If not, write to
  18  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  *)
  21
  22 open Apache
  23 open Registry
  24 open Cgi
  25 open Printf
  26
  27 open ExtString
  28
  29 open Cocanwiki
  30 open Cocanwiki_template
  31 open Cocanwiki_ok
  32 open Cocanwiki_date
  33
  34 (* Maximum level of redirection. *)
  35 let max_redirect = 4
  36
  37 type fp_status = FPOK of int * string * string * Dbi.datetime * bool
  38                | FPRedirect of string
  39                | FPNotFound
  40
  41 let run r (q : cgi) (dbh : Dbi.connection) hostid {edit_anon=edit_anon} user =
  42   let template_page = get_template dbh hostid "page.html" in
  43   let template_404  = get_template dbh hostid "page_404.html" in
  44
  45   let page = q#param "page" in
  46   let page = if page = "" then "index" else page in
  47
  48   (* Host-specific CSS? *)
  49   let sth = dbh#prepare_cached "select css is not null from hosts
  50                                  where id = ?" in
  51   sth#execute [`Int hostid];
  52   let has_host_css =
  53     match sth#fetch1 () with
  54       | [ `Bool has_host_css ] -> has_host_css
  55       | _ -> assert false in
  56
  57   (* Can the user edit?  Manage users?  etc. *)
  58   let can_edit = can_edit edit_anon user in
  59   let can_manage_users = can_manage_users user in
  60   let can_manage_contacts = can_manage_contacts user in
  61
  62   (* This code generates ordinary pages. *)
  63   let make_page title description pageid last_modified_date has_page_css
  64       version page page' =
  65     let t = template_page in
  66     t#set "title" title;
  67     t#set "description" description;
  68     t#set "pageid" (string_of_int pageid);
  69     t#set "last_modified_date" (printable_date last_modified_date);
  70
  71     if page <> page' then (* redirection *) (
  72       t#set "page" page';
  73       t#set "original_page" page; (* XXX title - get it from database *)
  74       t#conditional "redirected" true
  75     ) else (
  76       t#set "page" page;
  77       t#conditional "redirected" false
  78     );
  79
  80     t#conditional "has_host_css" has_host_css;
  81     t#conditional "has_page_css" has_page_css;
  82
  83     t#conditional "can_edit" can_edit;
  84     t#conditional "can_manage_users" can_manage_users;
  85     t#conditional "can_manage_contacts" can_manage_contacts;
  86
  87     (* Pull out the sections in this page. *)
  88     let sth = dbh#prepare_cached
  89                 "select ordering, sectionname, content, divname
  90                    from contents
  91                   where pageid = ?
  92                   order by ordering" in
  93     sth#execute [`Int pageid];
  94
  95     let sections =
  96       sth#map
  97         (function [`Int ordering;
  98                    (`Null | `String _) as sectionname;
  99                    `String content;
 100                    (`Null | `String _) as divname] ->
 101            let divname, has_divname =
 102              match divname with
 103                  `Null -> "", false
 104                | `String divname -> divname, true in
 105            let sectionname, has_sectionname =
 106              match sectionname with
 107                  `Null -> "", false
 108                | `String sectionname -> sectionname, true in
 109            let linkname = linkname_of_sectionname sectionname in
 110            [ "ordering", Template.VarString (string_of_int ordering);
 111              "has_sectionname", Template.VarConditional has_sectionname;
 112              "sectionname", Template.VarString sectionname;
 113              "linkname", Template.VarString linkname;
 114              "content",
 115                Template.VarString
 116                  (Wikilib.xhtml_of_content dbh hostid content);
 117              "has_divname", Template.VarConditional has_divname;
 118              "divname", Template.VarString divname ]
 119            | _ -> assert false) in
 120
 121     t#table "sections" sections;
 122
 123     (* Are we showing an old version of the page?  If so, warn. *)
 124     (match version with
 125          None ->
 126            t#conditional "is_old_version" false
 127        | Some pageid ->
 128            t#conditional "is_old_version" true;
 129            t#set "old_version" (string_of_int pageid));
 130
 131     (* Login status. *)
 132     (match user with
 133          Anonymous ->
 134            t#conditional "user_logged_in" false
 135        | User (_, username, _) ->
 136            t#conditional "user_logged_in" true;
 137            t#set "username" username);
 138
 139     q#template t
 140   in
 141
 142   (* This code generates 404 pages. *)
 143   let make_404 () =
 144     Request.set_status r 404;           (* Return a 404 error code. *)
 145
 146     let t = template_404 in
 147     t#set "page" page;
 148
 149     let search_terms =
 150       String.map
 151         (function
 152              ('a'..'z' | 'A'..'Z' | '0'..'9') as c -> c
 153            | _ -> ' ') page in
 154
 155     t#set "search_terms" search_terms;
 156
 157     t#conditional "has_host_css" has_host_css;
 158
 159     t#conditional "can_edit" can_edit;
 160     t#conditional "can_manage_users" can_manage_users;
 161     t#conditional "can_manage_contacts" can_manage_contacts;
 162
 163     q#template t
 164   in
 165
 166   (* Fetch a page by name.  This function can give three answers:
 167    * (1) Page fetched OK (fetches some details of the page).
 168    * (2) Page is a redirect (fetches the name of the redirect page).
 169    * (3) Page not found in database, ie. 404 error.
 170    *)
 171   (* XXX Should do a case-insensitive matching of URLs, and if the URL differs
 172    * in case only should redirect to the lowercase version.
 173    *)
 174   let fetch_page page version allow_redirect =
 175     match version with
 176       | None ->
 177           if allow_redirect then (
 178             let sth =
 179               dbh#prepare_cached
 180                 "select redirect, id, title, description, last_modified_date,
 181                         css is not null
 182                    from pages where hostid = ? and url = ?" in
 183             sth#execute [`Int hostid; `String page];
 184             (try
 185                (match sth#fetch1 () with
 186                   | [ `Null; `Int id; `String title; `String description;
 187                       `Timestamp last_modified_date; `Bool has_page_css ] ->
 188                       FPOK (id, title, description, last_modified_date,
 189                             has_page_css)
 190                   | `String redirect :: _ ->
 191                       FPRedirect redirect
 192                   | _ -> assert false)
 193              with
 194                  Not_found -> FPNotFound)
 195           ) else (* redirects not allowed ... *) (
 196             let sth =
 197               dbh#prepare_cached
 198                 "select id, title, description, last_modified_date,
 199                         css is not null
 200                    from pages where hostid = ? and url = ?" in
 201             sth#execute [`Int hostid; `String page];
 202             (try
 203                (match sth#fetch1 () with
 204                   | [ `Int id; `String title; `String description;
 205                       `Timestamp last_modified_date; `Bool has_page_css ] ->
 206                       FPOK (id, title, description, last_modified_date,
 207                             has_page_css)
 208                   | _ -> assert false)
 209              with
 210                  Not_found -> FPNotFound)
 211           )
 212       | Some version ->
 213             let sth =
 214               dbh#prepare_cached
 215                 "select id, title, description, last_modified_date,
 216                         css is not null
 217                    from pages
 218                   where hostid = ? and id = ? and
 219                         (url = ? or url_deleted = ?)" in
 220             sth#execute [`Int hostid; `Int version;
 221                          `String page; `String page];
 222             (try
 223                (match sth#fetch1 () with
 224                   | [ `Int id; `String title; `String description;
 225                       `Timestamp last_modified_date; `Bool has_page_css ] ->
 226                       FPOK (id, title, description, last_modified_date,
 227                             has_page_css)
 228                   | _ -> assert false)
 229              with
 230                  Not_found -> FPNotFound)
 231   in
 232
 233   (* Here we deal with the complex business of redirects and versions. *)
 234   (* Only allow the no_redirect and version syntax for editors. *)
 235   let allow_redirect, version =
 236     if can_edit then (
 237       not (q#param_true "no_redirect"),
 238       try Some (int_of_string (q#param "version")) with Not_found -> None
 239     ) else
 240       (true, None) in
 241
 242   let rec loop page' i =
 243     if i > max_redirect then (
 244       error ~title:"Too many redirections" ~back_button:true
 245         q ("Too many redirects between pages.  This may happen because " ^
 246            "of a cycle of redirections.");
 247       raise CgiExit
 248     ) else
 249       match fetch_page page' version allow_redirect with
 250         | FPOK (pageid, title, description, last_modified_date, has_page_css)->
 251             make_page title description pageid last_modified_date has_page_css
 252               version page page'
 253         | FPRedirect page' ->
 254             loop page' (i+1)
 255         | FPNotFound ->
 256             make_404 ()
 257   in
 258   loop page 0
 259
 260 let () =
 261   register_script run