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.9 2006/03/27 16:43:44 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 (* Our wrapper around the standard [register_script] function.
72 * The optional ~restrict and ~anonymous parameters work as follows:
74 * By default (neither parameter given), anonymous or logged-in users
75 * at any level are permitted to run the script.
77 * If ~anonymous:false then a user must be logged in to use the script.
79 * If ~restrict contains a list of permissions (eg. CanEdit, etc.) then
80 * the user must have the ability to do AT LEAST ONE of those actions.
81 * (Note that this does not necessarily imply that the user must be
82 * logged in, because in some circumstances even anonymous users have
83 * the CanEdit permission - very typical for a wiki).
85 * If ~anonymous:false and ~restrict is given then the user must be
86 * logged in AND have the ability to do AT LEAST ONE of those actions.
88 let register_script ?(restrict = []) ?(anonymous = true) run =
89 (* Actually register the script with the real [Registry] module. *)
94 (* XXX Database pooling. *)
95 let dbh = PGOCaml.connect ~database:"cocanwiki" () in
96 PGOCaml.begin_work dbh;
100 (* Get the host ID, by comparing the Host: header with the hostnames
101 * table in the database.
103 let hostid, hostname, canonical_hostname, edit_anon, view_anon =
104 let hostname = try Request.hostname r
106 error ~back_button:true
107 ~title:"Browser problem" dbh (-1l) q
108 ("Your browser didn't send a \"Host\" header as part of " ^
109 "the HTTP request. Unfortunately this web server cannot "^
110 "handle HTTP requests without a \"Host\" header.");
112 let hostname = String.lowercase hostname in
116 "select h.id, h.canonical_hostname, h.edit_anon, h.view_anon
117 from hostnames hn, hosts h
118 where hn.name = $hostname and hn.hostid = h.id" in
121 | [id, canonical_hostname, edit_anon, view_anon] ->
122 id, hostname, canonical_hostname, edit_anon, view_anon
124 error ~back_button:true
125 ~title:"Unknown website" dbh (-1l) q
126 ("No website called \"" ^ hostname ^ "\" can be found. " ^
127 "If you are the administrator of this site, check that " ^
128 "the hostname is listed in the \"hostnames\" table " ^
131 | _ -> assert false in
133 (* Create the host object. *)
134 let host = { hostname = hostname;
135 canonical_hostname = canonical_hostname;
136 edit_anon = edit_anon;
137 view_anon = view_anon } in
139 (* Look for the user's cookie, and determine from this the user
145 (* Allow the user to deliberately specify an extra "cookie"
146 * parameter, which we will send back as a cookie. This is
147 * useful for "mail my password"-type scripts.
149 if q#param_exists "cookie" then (
150 let value = q#param "cookie" in
151 let cookie = Cookie.cookie "auth" value ~path:"/" in
152 Table.set (Request.headers_out r)
153 "Set-Cookie" cookie#to_string;
156 (* Normal cookie, from the headers. *)
157 let header = Table.get (Request.headers_in r) "Cookie" in
158 let cookies = Cookie.parse header in
160 List.find (fun cookie -> cookie#name = "auth") cookies in
166 "select u.id, u.name, u.can_edit, u.can_manage_users,
167 u.can_manage_contacts, u.can_manage_site,
168 u.can_edit_global_css, u.can_import_mail,
169 u.email, u.email_notify
170 from usercookies uc, users u
171 where uc.cookie = $cookie
173 and u.hostid = $hostid" in
175 | [userid, name, can_edit, can_manage_users,
176 can_manage_contacts, can_manage_site,
177 can_edit_global_css, can_import_mail,
178 email, email_notify] ->
179 (* Every logged in user can view. *)
180 let perms = [CanView] in
182 if can_edit then CanEdit :: perms
185 if can_manage_users then CanManageUsers :: perms
188 if can_manage_contacts then CanManageContacts :: perms
191 if can_manage_site then CanManageSite :: perms
194 if can_edit_global_css then CanEditGlobalCSS :: perms
197 if can_import_mail then CanImportMail :: perms
200 let prefs = { email = email;
201 email_notify = email_notify; } in
202 User (userid, name, perms, prefs)
203 | [] -> raise Not_found
206 Not_found -> Anonymous in
208 (* If the ~restrict parameter is given, then we want to check that
209 * the user has sufficient permission to run this script.
212 if not anonymous && user = Anonymous then false
215 | [] -> true (* empty list = no restrictions *)
217 List.fold_left (||) false
218 (List.map (fun r -> test_permission host r user) rs) in
221 (* Call the actual CGI script. *)
222 run r q dbh hostid host user
224 if user = Anonymous then (
225 (* Not logged in and no permission to do the requested action,
226 * so redirect to the login script. If possible set the
227 * redirect parameter so that we return to the right URL.
231 (* If we passed through mod_rewrite, then it saved the
232 * unmodified original URL in a subprocess environment
233 * variable called SCRIPT_URL:
235 let tbl = Request.subprocess_env r in
236 Some (Table.get tbl "SCRIPT_URL")
240 (* Otherwise try the ordinary uri field
248 "http://" ^ hostname ^ "/_login" ^
251 | Some url -> "?redirect=" ^ Cgi_escape.escape_url url in
254 error ~back_button:true
255 ~title:"Access denied"
257 "You do not have permission to access this part of the site."
260 None (* no exception *)
264 (* XXX Connection pooling - see above. *)
267 (* May re-raise the caught exception. *)
271 (* Convert a section name into something valid for use in <a name="...">
272 * XXX This breaks horribly for non-7-bit strings.
273 * XXX This is stuck here because we don't have a good place for it, and
274 * because it needs to be fixed for i18n compliance.
276 let linkname_of_sectionname str =
277 let str = String.copy str in
278 for i = 0 to String.length str - 1 do
279 if not (isalnum str.[i]) then str.[i] <- '_'
283 (* List of extensions currently registered. *)
284 type extension_t = PGOCaml.pa_pg_data PGOCaml.t -> int32 -> string -> string
285 let extensions = ref ([] : (string * extension_t) list)
287 (* Maximum degree of redirection. *)