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.11 2004/09/23 11:56:47 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 (* Server-wide settings.
39 * These are stored in a single row in the database in the table
40 * 'server_settings'. You must restart the server if you change
43 * It's not possible to read these at server start-up time because the
44 * Apache server is still running as 'root' and will not normally be
45 * allowed to access the database. We thus read them at the earliest
46 * opportunity, in a request context, and cache the results.
48 let server_settings_version =
49 let settings = ref None in
50 let get_settings (dbh : Dbi.connection) =
51 let sth = dbh#prepare "select version from server_settings" in
54 match sth#fetch1 () with
55 | [ `Int version ] -> version
56 | _ -> assert false in
62 let server_settings_version dbh =
65 None -> get_settings dbh
66 | Some settings -> settings in
70 server_settings_version
72 (* The [CgiExit] exception should be folded back into the base
73 * mod_caml code at some point. It just causes the 'run' function to
74 * return at that point safely. (XXX)
78 let return () = raise CgiExit
80 (* Permissions and restrictions.
82 * Use the optional ~restrict parameter to register_script to restrict
83 * who can use the script. For example:
84 * register_script ~restrict:[CanEdit ; CanManageUsers] run
86 type permissions_t = CanEdit | CanManageUsers | CanManageContacts
87 | CanManageSite | CanEditGlobalCSS
89 (* The "user object". *)
90 type user_t = Anonymous (* Not logged in. *)
91 | User of int * string * permissions_t list
92 (* Userid, name, permissions. *)
94 let test_permission edit_anon perm user =
95 if perm = CanEdit && edit_anon then true
98 | User (_, _, perms) -> List.mem perm perms
100 let can_edit edit_anon = test_permission edit_anon CanEdit
101 let can_manage_users = test_permission false CanManageUsers
102 let can_manage_contacts = test_permission false CanManageContacts
103 let can_manage_site = test_permission false CanManageSite
104 let can_edit_global_css = test_permission false CanEditGlobalCSS
106 (* The "host object". *)
107 type host_t = { hostname : string;
110 (* Our wrapper around the standard [register_script] function.
112 * The optional ~restrict and ~anonymous parameters work as follows:
114 * By default (neither parameter given), anonymous or logged-in users
115 * at any level are permitted to run the script.
117 * If ~anonymous:false then a user must be logged in to use the script.
119 * If ~restrict contains a list of permissions (eg. CanEdit, etc.) then
120 * the user must have the ability to do AT LEAST ONE of those actions.
121 * (Note that this does not necessarily imply that the user must be
122 * logged in, because in some circumstances even anonymous users have
123 * the CanEdit permission - very typical for a wiki).
125 * If ~anonymous:false and ~restrict is given then the user must be
126 * logged in AND have the ability to do AT LEAST ONE of those actions.
128 let register_script ?(restrict = []) ?(anonymous = true) run =
129 (* Actually register the script with the real [Registry] module. *)
133 let dbh = _get_dbh r in
135 (* Get the host ID, by comparing the Host: header with the hostnames
136 * table in the database.
138 let hostid, hostname, edit_anon =
139 let hostname = try Request.hostname r
140 with Not_found -> failwith "No ``Host:'' header in request" in
141 let hostname = String.lowercase hostname in
145 "select h.id, h.canonical_hostname, h.edit_anon
146 from hostnames hn, hosts h
147 where hn.name = ? and hn.hostid = h.id" in
148 sth#execute [`String hostname];
151 (match sth#fetch1 () with
152 [ `Int id; `String hostname; `Bool edit_anon ] ->
153 id, hostname, edit_anon
157 failwith ("Hostname ``" ^ hostname ^ "'' not found in " ^
158 "the hosts/hostnames tables in the database.") in
160 (* Create the host object. *)
161 let host = { hostname = hostname; edit_anon = edit_anon; } in
163 (* Look for the user's cookie, and determine from this the user
169 (* Allow the user to deliberately specify an extra "cookie"
170 * parameter, which we will send back as a cookie. This is
171 * useful for "mail my password"-type scripts.
173 if q#param_exists "cookie" then (
174 let value = q#param "cookie" in
175 let cookie = Cookie.cookie ~name:"auth" ~value ~path:"/" () in
176 Table.set (Request.headers_out r) "Set-Cookie" cookie#as_string;
179 (* Normal cookie, from the headers. *)
180 let header = Table.get (Request.headers_in r) "Cookie" in
181 let cookies = Cookie.parse header in
183 List.find (fun cookie -> cookie#name = "auth") cookies in
189 "select u.id, u.name, u.can_edit, u.can_manage_users,
190 u.can_manage_contacts, u.can_manage_site,
191 u.can_edit_global_css
192 from usercookies uc, users u
193 where uc.cookie = ? and uc.userid = u.id and u.hostid = ?" in
194 sth#execute [`String cookie; `Int hostid];
195 (match sth#fetch1 () with
196 [ `Int userid; `String name;
197 `Bool can_edit; `Bool can_manage_users;
198 `Bool can_manage_contacts; `Bool can_manage_site;
199 `Bool can_edit_global_css ] ->
200 let perms = if can_edit then [ CanEdit ] else [] in
202 if can_manage_users then CanManageUsers :: perms
205 if can_manage_contacts then CanManageContacts :: perms
208 if can_manage_site then CanManageSite :: perms
211 if can_edit_global_css then CanEditGlobalCSS :: perms
213 User (userid, name, perms)
216 Not_found -> Anonymous
219 (* If the ~restrict parameter is given, then we want to check that
220 * the user has sufficient permission to run this script.
223 if not anonymous && user = Anonymous then false
226 [] -> true (* empty list = no restrictions *)
228 List.fold_left (||) false
229 (List.map (fun r -> test_permission edit_anon r user) rs) in
232 (* Call the actual CGI script. *)
234 run r q dbh hostid host user
238 error ~back_button:true
239 ~title:"Access denied"
240 q "You do not have permission to access this part of the site."
243 (* Convert a section name into something valid for use in <a name="...">
244 * XXX This breaks horribly for non-7-bit strings.
245 * XXX This is stuck here because we don't have a good place for it, and
246 * because it needs to be fixed for i18n compliance.
248 let linkname_of_sectionname str =
249 let str = String.copy str in
250 for i = 0 to String.length str - 1 do
251 if not (isalnum str.[i]) then str.[i] <- '_'