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.8 2005/11/24 14:54:15 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_postgresql)
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 "host object". *)
38 type host_t = { hostname : string;
39 canonical_hostname : string;
43 (* Permissions and restrictions.
45 * Use the optional ~restrict parameter to register_script to restrict
46 * who can use the script. For example:
47 * register_script ~restrict:[CanEdit ; CanManageUsers] run
49 type permissions_t = CanView | CanEdit | CanManageUsers | CanManageContacts
50 | CanManageSite | CanEditGlobalCSS | CanImportMail
52 (* User preferences and other settings (some cannot be changed by the user). *)
54 email : string option; (* Email address. *)
55 email_notify : bool; (* Email notification. *)
58 (* The "user object". *)
59 type user_t = Anonymous (* Not logged in. *)
60 | User of int * string * permissions_t list * prefs_t
61 (* Userid, name, perms, prefs. *)
63 let test_permission {edit_anon = edit_anon; view_anon = view_anon} perm user =
64 if perm = CanEdit && edit_anon then true
65 else if perm = CanView && view_anon then true
68 | User (_, _, perms, _) -> List.mem perm perms
70 let can_edit host = test_permission host CanEdit
71 let can_manage_users host = test_permission host CanManageUsers
72 let can_manage_contacts host = test_permission host CanManageContacts
73 let can_manage_site host = test_permission host CanManageSite
74 let can_edit_global_css host = test_permission host CanEditGlobalCSS
75 let can_import_mail host = test_permission host CanImportMail
77 (* Our wrapper around the standard [register_script] function.
79 * The optional ~restrict and ~anonymous parameters work as follows:
81 * By default (neither parameter given), anonymous or logged-in users
82 * at any level are permitted to run the script.
84 * If ~anonymous:false then a user must be logged in to use the script.
86 * If ~restrict contains a list of permissions (eg. CanEdit, etc.) then
87 * the user must have the ability to do AT LEAST ONE of those actions.
88 * (Note that this does not necessarily imply that the user must be
89 * logged in, because in some circumstances even anonymous users have
90 * the CanEdit permission - very typical for a wiki).
92 * If ~anonymous:false and ~restrict is given then the user must be
93 * logged in AND have the ability to do AT LEAST ONE of those actions.
95 let register_script ?(restrict = []) ?(anonymous = true) run =
96 (* Actually register the script with the real [Registry] module. *)
100 let dbh = _get_dbh r in
102 (* Get the host ID, by comparing the Host: header with the hostnames
103 * table in the database.
105 let hostid, hostname, canonical_hostname, edit_anon, view_anon =
106 let hostname = try Request.hostname r
108 error ~back_button:true
109 ~title:"Browser problem" dbh (-1) q
110 ("Your browser didn't send a \"Host\" header as part of " ^
111 "the HTTP request. Unfortunately this web server cannot " ^
112 "handle HTTP requests without a \"Host\" header.");
114 let hostname = String.lowercase hostname in
118 "select h.id, h.canonical_hostname, h.edit_anon, h.view_anon
119 from hostnames hn, hosts h
120 where hn.name = ? and hn.hostid = h.id" in
121 sth#execute [`String hostname];
124 (match sth#fetch1 () with
125 [ `Int id; `String canonical_hostname;
126 `Bool edit_anon; `Bool view_anon ] ->
127 id, hostname, canonical_hostname, edit_anon, view_anon
131 error ~back_button:true
132 ~title:"Unknown website" dbh (-1) q
133 ("No website called \"" ^ hostname ^ "\" can be found. " ^
134 "If you are the administrator of this site, check that " ^
135 "the hostname is listed in the \"hostnames\" table " ^
139 (* Create the host object. *)
140 let host = { hostname = hostname;
141 canonical_hostname = canonical_hostname;
142 edit_anon = edit_anon;
143 view_anon = view_anon } in
145 (* Look for the user's cookie, and determine from this the user
151 (* Allow the user to deliberately specify an extra "cookie"
152 * parameter, which we will send back as a cookie. This is
153 * useful for "mail my password"-type scripts.
155 if q#param_exists "cookie" then (
156 let value = q#param "cookie" in
157 let cookie = Cookie.cookie "auth" value ~path:"/" in
158 Table.set (Request.headers_out r) "Set-Cookie" cookie#to_string;
161 (* Normal cookie, from the headers. *)
162 let header = Table.get (Request.headers_in r) "Cookie" in
163 let cookies = Cookie.parse header in
165 List.find (fun cookie -> cookie#name = "auth") cookies in
171 "select u.id, u.name, u.can_edit, u.can_manage_users,
172 u.can_manage_contacts, u.can_manage_site,
173 u.can_edit_global_css, u.can_import_mail,
174 u.email, u.email_notify
175 from usercookies uc, users u
176 where uc.cookie = ? and uc.userid = u.id and u.hostid = ?" in
177 sth#execute [`String cookie; `Int hostid];
178 (match sth#fetch1 () with
179 [ `Int userid; `String name;
180 `Bool can_edit; `Bool can_manage_users;
181 `Bool can_manage_contacts; `Bool can_manage_site;
182 `Bool can_edit_global_css; `Bool can_import_mail;
183 (`Null | `String _) as email; `Bool email_notify ] ->
184 (* Every logged in user can view. *)
185 let perms = [CanView] in
187 if can_edit then CanEdit :: perms
190 if can_manage_users then CanManageUsers :: perms
193 if can_manage_contacts then CanManageContacts :: perms
196 if can_manage_site then CanManageSite :: perms
199 if can_edit_global_css then CanEditGlobalCSS :: perms
202 if can_import_mail then CanImportMail :: perms
208 | `String email -> Some email in
209 let prefs = { email = email;
210 email_notify = email_notify; } in
211 User (userid, name, perms, prefs)
214 Not_found -> Anonymous
217 (* If the ~restrict parameter is given, then we want to check that
218 * the user has sufficient permission to run this script.
221 if not anonymous && user = Anonymous then false
224 [] -> true (* empty list = no restrictions *)
226 List.fold_left (||) false
227 (List.map (fun r -> test_permission host r user) rs) in
230 (* Call the actual CGI script. *)
231 run r q dbh hostid host user
233 if user = Anonymous then (
234 (* Not logged in and no permission to do the requested action,
235 * so redirect to the login script. If possible set the
236 * redirect parameter so that we return to the right URL.
240 (* If we passed through mod_rewrite, then it saved the
241 * unmodified original URL in a subprocess environment
242 * variable called SCRIPT_URL:
244 let tbl = Request.subprocess_env r in
245 Some (Table.get tbl "SCRIPT_URL")
249 (* Otherwise try the ordinary uri field in request_rec. *)
255 "http://" ^ hostname ^ "/_login" ^
258 | Some url -> "?redirect=" ^ Cgi_escape.escape_url url in
261 error ~back_button:true
262 ~title:"Access denied"
264 "You do not have permission to access this part of the site."
268 (* Convert a section name into something valid for use in <a name="...">
269 * XXX This breaks horribly for non-7-bit strings.
270 * XXX This is stuck here because we don't have a good place for it, and
271 * because it needs to be fixed for i18n compliance.
273 let linkname_of_sectionname str =
274 let str = String.copy str in
275 for i = 0 to String.length str - 1 do
276 if not (isalnum str.[i]) then str.[i] <- '_'
280 (* List of extensions currently registered. *)
281 type extension_t = Dbi.connection -> int -> string -> string
282 let extensions = ref ([] : (string * extension_t) list)
284 (* Maximum degree of redirection. *)