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.10 2006/03/28 16:24:08 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 (* The "host object". *)
31 type host_t = { hostname : string;
32 canonical_hostname : string;
36 (* Permissions and restrictions.
38 * Use the optional ~restrict parameter to register_script to restrict
39 * who can use the script. For example:
40 * register_script ~restrict:[CanEdit ; CanManageUsers] run
42 type permissions_t = CanView | CanEdit | CanManageUsers | CanManageContacts
43 | CanManageSite | CanEditGlobalCSS | CanImportMail
45 (* User preferences and other settings (some cannot be changed by the user). *)
47 email : string option; (* Email address. *)
48 email_notify : bool; (* Email notification. *)
51 (* The "user object". *)
52 type user_t = Anonymous (* Not logged in. *)
53 | User of int32 * string * permissions_t list * prefs_t
54 (* Userid, name, perms, prefs. *)
56 let test_permission {edit_anon = edit_anon; view_anon = view_anon} perm user =
57 if perm = CanEdit && edit_anon then true
58 else if perm = CanView && view_anon then true
61 | User (_, _, perms, _) -> List.mem perm perms
63 let can_edit host = test_permission host CanEdit
64 let can_manage_users host = test_permission host CanManageUsers
65 let can_manage_contacts host = test_permission host CanManageContacts
66 let can_manage_site host = test_permission host CanManageSite
67 let can_edit_global_css host = test_permission host CanEditGlobalCSS
68 let can_import_mail host = test_permission host CanImportMail
70 let get_uri_from_request r =
72 (* If we passed through mod_rewrite, then it saved the
73 * unmodified original URL in a subprocess environment
74 * variable called SCRIPT_URL:
76 let tbl = Request.subprocess_env r in
77 Some (Table.get tbl "SCRIPT_URL")
81 (* Otherwise try the ordinary uri field
88 (* Our wrapper around the standard [register_script] function.
90 * The optional ~restrict and ~anonymous parameters work as follows:
92 * By default (neither parameter given), anonymous or logged-in users
93 * at any level are permitted to run the script.
95 * If ~anonymous:false then a user must be logged in to use the script.
97 * If ~restrict contains a list of permissions (eg. CanEdit, etc.) then
98 * the user must have the ability to do AT LEAST ONE of those actions.
99 * (Note that this does not necessarily imply that the user must be
100 * logged in, because in some circumstances even anonymous users have
101 * the CanEdit permission - very typical for a wiki).
103 * If ~anonymous:false and ~restrict is given then the user must be
104 * logged in AND have the ability to do AT LEAST ONE of those actions.
106 let register_script ?(restrict = []) ?(anonymous = true) run =
107 (* Actually register the script with the real [Registry] module. *)
112 (* XXX Database pooling. *)
113 let dbh = PGOCaml.connect ~database:"cocanwiki" () in
114 PGOCaml.begin_work dbh;
118 (* Get the host ID, by comparing the Host: header with the hostnames
119 * table in the database.
121 let hostid, hostname, canonical_hostname, edit_anon, view_anon =
123 try Request.hostname r
125 error ~back_button:true
126 ~title:"Browser problem" dbh (-1l) q
127 ("Your browser didn't send a \"Host\" header as part of " ^
128 "the HTTP request. Unfortunately this web server " ^
129 "cannot handle HTTP requests without a \"Host\" " ^
132 let hostname = String.lowercase hostname in
136 "select h.id, h.canonical_hostname, h.edit_anon, h.view_anon
137 from hostnames hn, hosts h
138 where hn.name = $hostname and hn.hostid = h.id" in
141 | [id, canonical_hostname, edit_anon, view_anon] ->
142 id, hostname, canonical_hostname, edit_anon, view_anon
144 error ~back_button:true
145 ~title:"Unknown website" dbh (-1l) q
146 ("No website called \"" ^ hostname ^ "\" can be found. " ^
147 "If you are the administrator of this site, check that " ^
148 "the hostname is listed in the \"hostnames\" table " ^
151 | _ -> assert false in
153 (* Create the host object. *)
154 let host = { hostname = hostname;
155 canonical_hostname = canonical_hostname;
156 edit_anon = edit_anon;
157 view_anon = view_anon } in
159 (* Look for the user's cookie, and determine from this the user
165 (* Allow the user to deliberately specify an extra "cookie"
166 * parameter, which we will send back as a cookie. This is
167 * useful for "mail my password"-type scripts.
169 if q#param_exists "cookie" then (
170 let value = q#param "cookie" in
171 let cookie = Cookie.cookie "auth" value ~path:"/" in
172 Table.set (Request.headers_out r)
173 "Set-Cookie" cookie#to_string;
176 (* Normal cookie, from the headers. *)
177 let header = Table.get (Request.headers_in r) "Cookie" in
178 let cookies = Cookie.parse header in
180 List.find (fun cookie -> cookie#name = "auth") cookies in
186 "select u.id, u.name, u.can_edit, u.can_manage_users,
187 u.can_manage_contacts, u.can_manage_site,
188 u.can_edit_global_css, u.can_import_mail,
189 u.email, u.email_notify
190 from usercookies uc, users u
191 where uc.cookie = $cookie
193 and u.hostid = $hostid" in
195 | [userid, name, can_edit, can_manage_users,
196 can_manage_contacts, can_manage_site,
197 can_edit_global_css, can_import_mail,
198 email, email_notify] ->
199 (* Every logged in user can view. *)
200 let perms = [CanView] in
202 if can_edit then CanEdit :: perms
205 if can_manage_users then CanManageUsers :: perms
208 if can_manage_contacts then CanManageContacts :: perms
211 if can_manage_site then CanManageSite :: perms
214 if can_edit_global_css then CanEditGlobalCSS :: perms
217 if can_import_mail then CanImportMail :: perms
220 let prefs = { email = email;
221 email_notify = email_notify; } in
222 User (userid, name, perms, prefs)
223 | [] -> raise Not_found
226 Not_found -> Anonymous in
228 (* If the ~restrict parameter is given, then we want to check that
229 * the user has sufficient permission to run this script.
232 if not anonymous && user = Anonymous then false
235 | [] -> true (* empty list = no restrictions *)
237 List.fold_left (||) false
238 (List.map (fun r -> test_permission host r user) rs) in
241 (* Call the actual CGI script. *)
242 run r q dbh hostid host user
244 if user = Anonymous then (
245 (* Not logged in and no permission to do the requested action,
246 * so redirect to the login script. If possible set the
247 * redirect parameter so that we return to the right URL.
249 let redirect = get_uri_from_request r in
252 "http://" ^ hostname ^ "/_login" ^
255 | Some url -> "?redirect=" ^ Cgi_escape.escape_url url in
258 error ~back_button:true
259 ~title:"Access denied"
261 "You do not have permission to access this part of the site."
264 None (* no exception *)
268 (* XXX Connection pooling - see above. *)
271 (* To help with debugging, if there is an exception, print some
276 fprintf stderr "COCANWIKI exception: %S\n" (Std.dump exn);
277 fprintf stderr "Time: %s\n"
278 (Printer.CalendarPrinter.to_string (Calendar.now ()));
280 try Some (Request.hostname r) with Not_found -> None in
281 fprintf stderr "Host: ";
283 | None -> fprintf stderr "not available\n"
284 | Some hostname -> fprintf stderr "%S\n" hostname
286 let uri = get_uri_from_request r in
287 fprintf stderr "Request: ";
289 | None -> fprintf stderr "not available\n"
290 | Some uri -> fprintf stderr "%S\n" uri
295 (* May re-raise the caught exception. *)
299 (* Convert a section name into something valid for use in <a name="...">
300 * XXX This breaks horribly for non-7-bit strings.
301 * XXX This is stuck here because we don't have a good place for it, and
302 * because it needs to be fixed for i18n compliance.
304 let linkname_of_sectionname str =
305 let str = String.copy str in
306 for i = 0 to String.length str - 1 do
307 if not (isalnum str.[i]) then str.[i] <- '_'
311 (* List of extensions currently registered. *)
312 type extension_t = PGOCaml.pa_pg_data PGOCaml.t -> int32 -> string -> string
313 let extensions = ref ([] : (string * extension_t) list)
315 (* Maximum degree of redirection. *)