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.12 2004/09/23 15:16:21 rich Exp $
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.
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.
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.
28 open Cocanwiki_strings
30 module Pool = DbiPool (Dbi_postgres)
32 (* This function is used to grab a database handle. It's used in a couple
33 * of very special places, and is not for general consumption.
35 let _get_dbh r = Pool.get r "cocanwiki"
37 (* The [CgiExit] exception should be folded back into the base
38 * mod_caml code at some point. It just causes the 'run' function to
39 * return at that point safely. (XXX)
43 let return () = raise CgiExit
45 (* Permissions and restrictions.
47 * Use the optional ~restrict parameter to register_script to restrict
48 * who can use the script. For example:
49 * register_script ~restrict:[CanEdit ; CanManageUsers] run
51 type permissions_t = CanEdit | CanManageUsers | CanManageContacts
52 | CanManageSite | CanEditGlobalCSS
54 (* The "user object". *)
55 type user_t = Anonymous (* Not logged in. *)
56 | User of int * string * permissions_t list
57 (* Userid, name, permissions. *)
59 let test_permission edit_anon perm user =
60 if perm = CanEdit && edit_anon then true
63 | User (_, _, perms) -> List.mem perm perms
65 let can_edit edit_anon = test_permission edit_anon CanEdit
66 let can_manage_users = test_permission false CanManageUsers
67 let can_manage_contacts = test_permission false CanManageContacts
68 let can_manage_site = test_permission false CanManageSite
69 let can_edit_global_css = test_permission false CanEditGlobalCSS
71 (* The "host object". *)
72 type host_t = { hostname : string;
75 (* Our wrapper around the standard [register_script] function.
77 * The optional ~restrict and ~anonymous parameters work as follows:
79 * By default (neither parameter given), anonymous or logged-in users
80 * at any level are permitted to run the script.
82 * If ~anonymous:false then a user must be logged in to use the script.
84 * If ~restrict contains a list of permissions (eg. CanEdit, etc.) then
85 * the user must have the ability to do AT LEAST ONE of those actions.
86 * (Note that this does not necessarily imply that the user must be
87 * logged in, because in some circumstances even anonymous users have
88 * the CanEdit permission - very typical for a wiki).
90 * If ~anonymous:false and ~restrict is given then the user must be
91 * logged in AND have the ability to do AT LEAST ONE of those actions.
93 let register_script ?(restrict = []) ?(anonymous = true) run =
94 (* Actually register the script with the real [Registry] module. *)
98 let dbh = _get_dbh r in
100 (* Get the host ID, by comparing the Host: header with the hostnames
101 * table in the database.
103 let hostid, hostname, edit_anon =
104 let hostname = try Request.hostname r
105 with Not_found -> failwith "No ``Host:'' header in request" in
106 let hostname = String.lowercase hostname in
110 "select h.id, h.canonical_hostname, h.edit_anon
111 from hostnames hn, hosts h
112 where hn.name = ? and hn.hostid = h.id" in
113 sth#execute [`String hostname];
116 (match sth#fetch1 () with
117 [ `Int id; `String hostname; `Bool edit_anon ] ->
118 id, hostname, edit_anon
122 failwith ("Hostname ``" ^ hostname ^ "'' not found in " ^
123 "the hosts/hostnames tables in the database.") in
125 (* Create the host object. *)
126 let host = { hostname = hostname; edit_anon = edit_anon; } in
128 (* Look for the user's cookie, and determine from this the user
134 (* Allow the user to deliberately specify an extra "cookie"
135 * parameter, which we will send back as a cookie. This is
136 * useful for "mail my password"-type scripts.
138 if q#param_exists "cookie" then (
139 let value = q#param "cookie" in
140 let cookie = Cookie.cookie ~name:"auth" ~value ~path:"/" () in
141 Table.set (Request.headers_out r) "Set-Cookie" cookie#as_string;
144 (* Normal cookie, from the headers. *)
145 let header = Table.get (Request.headers_in r) "Cookie" in
146 let cookies = Cookie.parse header in
148 List.find (fun cookie -> cookie#name = "auth") cookies in
154 "select u.id, u.name, u.can_edit, u.can_manage_users,
155 u.can_manage_contacts, u.can_manage_site,
156 u.can_edit_global_css
157 from usercookies uc, users u
158 where uc.cookie = ? and uc.userid = u.id and u.hostid = ?" in
159 sth#execute [`String cookie; `Int hostid];
160 (match sth#fetch1 () with
161 [ `Int userid; `String name;
162 `Bool can_edit; `Bool can_manage_users;
163 `Bool can_manage_contacts; `Bool can_manage_site;
164 `Bool can_edit_global_css ] ->
165 let perms = if can_edit then [ CanEdit ] else [] in
167 if can_manage_users then CanManageUsers :: perms
170 if can_manage_contacts then CanManageContacts :: perms
173 if can_manage_site then CanManageSite :: perms
176 if can_edit_global_css then CanEditGlobalCSS :: perms
178 User (userid, name, perms)
181 Not_found -> Anonymous
184 (* If the ~restrict parameter is given, then we want to check that
185 * the user has sufficient permission to run this script.
188 if not anonymous && user = Anonymous then false
191 [] -> true (* empty list = no restrictions *)
193 List.fold_left (||) false
194 (List.map (fun r -> test_permission edit_anon r user) rs) in
197 (* Call the actual CGI script. *)
199 run r q dbh hostid host user
203 error ~back_button:true
204 ~title:"Access denied"
205 q "You do not have permission to access this part of the site."
208 (* Convert a section name into something valid for use in <a name="...">
209 * XXX This breaks horribly for non-7-bit strings.
210 * XXX This is stuck here because we don't have a good place for it, and
211 * because it needs to be fixed for i18n compliance.
213 let linkname_of_sectionname str =
214 let str = String.copy str in
215 for i = 0 to String.length str - 1 do
216 if not (isalnum str.[i]) then str.[i] <- '_'