scripts/cocanwiki.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: cocanwiki.ml,v 1.6 2004/09/09 12:21:22 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 Cocanwiki_ok
  28
  29 module Pool = DbiPool (Dbi_postgres)
  30
  31 (* This function is used to grab a database handle.  It's used in a couple
  32  * of very special places, and is not for general consumption.
  33  *)
  34 let _get_dbh r = Pool.get r "cocanwiki"
  35
  36 (* The [CgiExit] exception should be folded back into the base
  37  * mod_caml code at some point.  It just causes the 'run' function to
  38  * return at that point safely.  (XXX)
  39  *)
  40 exception CgiExit
  41
  42 (* Permissions and restrictions.
  43  *
  44  * Use the optional ~restrict parameter to register_script to restrict
  45  * who can use the script.  For example:
  46  *   register_script ~restrict:[CanEdit ; CanManageUsers] run
  47  *)
  48 type permissions_t = CanEdit | CanManageUsers
  49
  50 (* The "user object". *)
  51 type user_t = Anonymous                 (* Not logged in. *)
  52             | User of int * string * permissions_t list
  53                                         (* Userid, name, permissions. *)
  54
  55 let test_permission edit_anon perm user =
  56   if perm = CanEdit && edit_anon then true
  57   else match user with
  58       Anonymous -> false
  59     | User (_, _, perms) -> List.mem perm perms
  60
  61 let can_edit edit_anon = test_permission edit_anon CanEdit
  62 let can_manage_users = test_permission false CanManageUsers
  63
  64 (* The "host object". *)
  65 type host_t = { hostname : string;
  66                 edit_anon : bool; }
  67
  68 (* Our wrapper around the standard [register_script] function.
  69  *
  70  * The optional ~restrict and ~anonymous parameters work as follows:
  71  *
  72  * By default (neither parameter given), anonymous or logged-in users
  73  * at any level are permitted to run the script.
  74  *
  75  * If ~anonymous:false then a user must be logged in to use the script.
  76  *
  77  * If ~restrict contains a list of permissions (eg. CanEdit, etc.) then
  78  * the user must have the ability to do AT LEAST ONE of those actions.
  79  * (Note that this does not necessarily imply that the user must be
  80  * logged in, because in some circumstances even anonymous users have
  81  * the CanEdit permission - very typical for a wiki).
  82  *
  83  * If ~anonymous:false and ~restrict is given then the user must be
  84  * logged in AND have the ability to do AT LEAST ONE of those actions.
  85  *)
  86 let register_script ?(restrict = []) ?(anonymous = true) run =
  87   (* Actually register the script with the real [Registry] module. *)
  88   register_script
  89     (fun r ->
  90        let q = new cgi r in
  91        let dbh = _get_dbh r in
  92
  93        (* Get the host ID, by comparing the Host: header with the hostnames
  94         * table in the database.
  95         *)
  96        let hostid, hostname, edit_anon =
  97          let hostname = try Request.hostname r
  98          with Not_found -> failwith "No ``Host:'' header in request" in
  99          let hostname = String.lowercase hostname in
 100
 101          let sth =
 102            dbh#prepare_cached
 103              "select h.id, h.canonical_hostname, h.edit_anon
 104                 from hostnames hn, hosts h
 105                where hn.name = ? and hn.hostid = h.id" in
 106          sth#execute [`String hostname];
 107
 108          try
 109            (match sth#fetch1 () with
 110                 [ `Int id; `String hostname; `Bool edit_anon ] ->
 111                   id, hostname, edit_anon
 112               | _ -> assert false)
 113          with
 114              Not_found ->
 115                failwith ("Hostname ``" ^ hostname ^ "'' not found in " ^
 116                          "the hosts/hostnames tables in the database.") in
 117
 118        (* Create the host object. *)
 119        let host = { hostname = hostname; edit_anon = edit_anon; } in
 120
 121        (* Look for the user's cookie, and determine from this the user
 122         * object.
 123         *)
 124        let user =
 125          try
 126            let cookie =
 127              (* Allow the user to deliberately specify an extra "cookie"
 128               * parameter, which we will send back as a cookie.  This is
 129               * useful for "mail my password"-type scripts.
 130               *)
 131              if q#param_exists "cookie" then (
 132                let value = q#param "cookie" in
 133                let cookie = Cookie.cookie ~name:"auth" ~value ~path:"/" () in
 134                Table.set (Request.headers_out r) "Set-Cookie" cookie#as_string;
 135                value
 136              ) else (
 137                (* Normal cookie, from the headers. *)
 138                let header = Table.get (Request.headers_in r) "Cookie" in
 139                let cookies = Cookie.parse header in
 140                let cookie =
 141                  List.find (fun cookie -> cookie#name = "auth") cookies in
 142                cookie#value
 143              ) in
 144
 145            let sth =
 146              dbh#prepare_cached
 147                "select u.id, u.name, u.can_edit, u.can_manage_users
 148                   from usercookies uc, users u
 149                  where uc.cookie = ? and uc.userid = u.id and u.hostid = ?" in
 150            sth#execute [`String cookie; `Int hostid];
 151            (match sth#fetch1 () with
 152                 [ `Int userid; `String name;
 153                   `Bool can_edit; `Bool can_manage_users ] ->
 154                   let perms =
 155                     (if can_edit then [ CanEdit ] else []) @
 156                     (if can_manage_users then [ CanManageUsers ] else []) in
 157                   User (userid, name, perms)
 158               | _ -> assert false)
 159          with
 160              Not_found -> Anonymous
 161        in
 162
 163        (* If the ~restrict parameter is given, then we want to check that
 164         * the user has sufficient permission to run this script.
 165         *)
 166        let permitted =
 167          if not anonymous && user = Anonymous then false
 168          else
 169            match restrict with
 170                [] -> true               (* empty list = no restrictions *)
 171              | rs ->
 172                  List.fold_left ((||)) false
 173                    (List.map (fun r -> test_permission edit_anon r user) rs) in
 174
 175        if permitted then (
 176          (* Call the actual CGI script. *)
 177          try
 178            run r q dbh hostid host user
 179          with
 180              CgiExit -> ()
 181        ) else
 182          error ~back_button:true
 183            ~title:"Access denied"
 184            q "You do not have permission to access this part of the site."
 185     )