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: edit.ml,v 1.10 2004/09/21 13:01: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.
30 open Cocanwiki_template
32 open Cocanwiki_emailnotify
34 open Cocanwiki_strings
36 (* We keep an "internal model" of the page - see build_internal_model ()
40 id : int; (* Original page ID. *)
41 description : string; (* Description. *)
42 redirect : string; (* Redirect to ("" = none). *)
43 contents : (string * string * string) list;
44 (* (sectionname, divname, content)
45 * for each section. *)
48 let run r (q : cgi) (dbh : Dbi.connection) hostid {hostname = hostname} user =
49 let template = get_template dbh hostid "edit.html" in
50 let template_conflict = get_template dbh hostid "edit_conflict.html" in
52 (* Workaround bugs in IE, specifically lack of support for <button>
57 let ua = Table.get (Request.headers_in r) "User-Agent" in
58 ignore (String.find ua "MSIE"); (* Throws Invalid_string if not found. *)
61 Not_found | String.Invalid_string -> false in
62 template#conditional "msie" msie;
64 (* Build the internal model from the parameters passed to the script. *)
65 let build_internal_model () =
66 let id = int_of_string (q#param "id") in
67 let description = q#param "description" in
68 let redirect = q#param "redirect" in
70 let contents = ref [] in
72 while q#param_exists ("content_" ^ string_of_int !i) do
73 let sectionname = q#param ("sectionname_" ^ string_of_int !i) in
74 let content = q#param ("content_" ^ string_of_int !i) in
75 let divname = q#param ("divname_" ^ string_of_int !i) in
76 contents := (sectionname, divname, content) :: !contents;
79 let contents = List.rev !contents in
82 description = description;
84 contents = contents; }
87 (* Check for errors in the model. *)
88 let check_for_errors model =
89 let errors = ref [] in
90 let add_error msg = errors := msg :: !errors in
91 let get_errors () = List.rev !errors in
93 if model.redirect = "" then (
95 if model.contents = [] then
96 add_error ("This page is empty. Use 'Insert new section here' " ^
97 "to write something!");
99 (* Description field? *)
100 if model.description = "" then
101 add_error ("The description field is very important! This field is " ^
102 "used by search engines and directories to describe " ^
103 "what's on this page.");
105 else (* it's a redirect *) (
106 (* Redirect points to a real page? *)
107 let sth = dbh#prepare_cached "select 1 from pages
112 and redirect is null" in
113 sth#execute [`Int hostid; `String model.redirect; `Int model.id];
115 let ok = try sth#fetch1 () = [`Int 1] with Not_found -> false in
117 add_error ("Redirect must point to an ordinary page " ^
118 "(ie. not to a page which is itself a redirect).")
121 (* All sections after the first one have sectionnames? The first
122 * section ONLY is allowed to have an empty title.
124 if model.contents <> [] then
125 List.iter (function (sectionnames, _, _)
126 when string_is_whitespace sectionnames ->
128 ("Every section except the first must have a title.");
130 (List.tl model.contents);
135 (* Various "actions" that can be performed on the model. *)
136 let action_insert model posn item =
137 (* posn = 0 means insert before the first element of the current list. *)
142 | n, x :: xs -> x :: (loop (n-1, xs))
144 let contents = loop (posn, model.contents) in
145 { model with contents = contents }
147 let action_moveup model posn =
148 (* posn = 1 means move up the first element, ie. do nothing
149 * posn = 2 means move up the second element to the first position
157 | 2, x :: y :: xs -> y :: x :: xs
158 | n, x :: xs -> x :: (loop (n-1, xs))
160 let contents = loop (posn, model.contents) in
161 { model with contents = contents }
163 let action_movedn model posn =
164 (* posn = 1 means move down the first element to the second position
171 | 1, x :: y :: xs -> y :: x :: xs
172 | n, x :: xs -> x :: (loop (n-1, xs))
174 let contents = loop (posn, model.contents) in
175 { model with contents = contents }
177 let action_delete model posn =
178 (* posn = 1 means delete the first element *)
184 | n, x :: xs -> x :: (loop (n-1, xs))
186 let contents = loop (posn, model.contents) in
187 { model with contents = contents }
190 (* Convert model to template. *)
191 let model_to_template model template =
192 template#set "id" (string_of_int model.id);
193 template#set "description" model.description;
195 (* Redirects table. *)
196 let sth = dbh#prepare_cached "select url, title from pages
197 where url is not null
199 and hostid = ? and id <> ?
201 sth#execute [`Int hostid; `Int model.id];
202 let table = sth#map (function [`String url; `String title] ->
203 let selected = model.redirect = url in
204 [ "url", Template.VarString url;
205 "title", Template.VarString title;
206 "selected", Template.VarConditional selected ]
207 | _ -> assert false) in
208 template#table "redirects" table;
210 (* Need to go to the database to get the title of the page ... *)
211 let sth = dbh#prepare_cached "select title from pages
212 where hostid = ? and id = ?" in
213 sth#execute [`Int hostid; `Int model.id];
214 let title = sth#fetch1string () in
215 template#set "title" title;
217 let ordering = ref 0 in
220 (fun (sectionname, divname, content) ->
221 incr ordering; let ordering = !ordering in
222 [ "ordering", Template.VarString (string_of_int ordering);
223 "sectionname", Template.VarString sectionname;
224 "divname", Template.VarString divname;
225 "content", Template.VarString content ]) model.contents in
226 template#table "contents" table;
228 (* Check for errors and put those into the template. *)
229 let errors = check_for_errors model in
230 let errors = List.map (fun msg ->
231 [ "error", Template.VarString msg ]) errors in
232 template#table "errors" errors;
233 template#conditional "has_errors" (errors <> [])
236 (* Begin editing a page, pulling the page out of the database and building
239 let begin_editing page =
240 (* Pull out the page itself from the database. *)
241 let sth = dbh#prepare_cached "select id, title, description,
242 coalesce (redirect, '')
244 where hostid = ? and url = ?" in
245 sth#execute [`Int hostid; `String page];
247 let pageid, title, description, redirect =
248 match sth#fetch1 () with
249 [`Int pageid; `String title; `String description; `String redirect]->
250 pageid, title, description, redirect
251 | _ -> assert false in
253 (* Get the sections. *)
254 let sth = dbh#prepare_cached "select coalesce (sectionname, ''),
256 coalesce (divname, '')
259 order by ordering" in
260 sth#execute [`Int pageid];
264 | [`String sectionname; `String content; `String divname] ->
265 sectionname, divname, content
266 | _ -> assert false) in
268 let model = { id = pageid;
269 description = description;
271 contents = contents; } in
273 model_to_template model template
276 let continue_editing () =
277 let model = ref (build_internal_model ()) in
279 (* An "action" parameter? *)
280 let is_action, get_action =
281 let actions = q#params in
282 (* Don't actually care about the value fields ... *)
283 let actions = List.map (fun (str, _) -> str) actions in
284 (* Some of our actions are imagemaps, so parameters like name.x, name.y
285 * need to be changed to name and have resulting duplicates removed.
288 List.filter (fun str ->
289 String.length str > 7 &&
290 String.sub str 0 7 = "action_" &&
291 not (String.ends_with str ".y")) actions in
294 if String.ends_with str ".x" then (
295 let str = String.sub str 0 (String.length str - 2) in
301 let action_type = String.sub str 7 6 in
303 String.sub str 14 (String.length str - 14) in
304 let action_value = int_of_string action_value in
305 action_type, action_value) actions in
307 let is_action typ = List.mem_assoc typ actions in
308 let get_value typ = List.assoc typ actions in
313 if is_action "insert" then (
314 let posn = get_action "insert" in
315 let item = "New section - change this", "", "Write some content here." in
316 model := action_insert !model posn item
317 ) else if is_action "moveup" then (
318 let posn = get_action "moveup" in
319 model := action_moveup !model posn
320 ) else if is_action "movedn" then (
321 let posn = get_action "movedn" in
322 model := action_movedn !model posn
323 ) else if is_action "delete" then (
324 let posn = get_action "delete" in
325 model := action_delete !model posn
328 model_to_template !model template
331 (* Try to save the page. Returns a boolean indicating if the
332 * page was saved successfully.
335 let model = build_internal_model () in
336 let no_errors = [] = check_for_errors model in
338 (* No errors, so we can save the page ... *)
340 (* Pull out fields from the database. *)
341 let sth = dbh#prepare_cached "select creation_date,
342 coalesce (url, url_deleted),
345 where hostid = ? and id = ?" in
346 sth#execute [`Int hostid; `Int model.id];
348 let creation_date, url, title, css =
349 match sth#fetch1 () with
350 [ creation_date; `String url; `String title; css ] ->
351 creation_date, url, title, css
352 | _ -> assert false in
354 (* Has someone else edited this page in the meantime? *)
355 let sth = dbh#prepare_cached "select max(id) from pages
356 where hostid = ? and url = ?" in
357 sth#execute [`Int hostid; `String url];
359 let max_id = sth#fetch1int () in
360 let edited = max_id <> model.id in
363 (* Edited by someone else ... Get the other's changes. *)
365 get_diff dbh hostid url ~old_version:model.id ~version:max_id () in
367 (* Synthesize our own changes. *)
368 let old_page = get_version_for_diff dbh model.id in
370 let css = match css with
371 `Null -> "" | `String css -> css
372 | _ -> assert false in
373 page_for_diff css (List.map (fun (sectionname, _, content) ->
374 sectionname, content) model.contents) in
375 let our_diff = diff_cmd old_page new_page in
377 (* Fill out the conflict template. *)
378 template_conflict#set "other_diff" other_diff;
379 template_conflict#set "our_diff" our_diff;
380 template_conflict#set "old_version" (string_of_int model.id);
381 template_conflict#set "new_version" (string_of_int max_id);
382 template_conflict#set "url" url;
384 q#template template_conflict;
388 (* Defer the pages_redirect_cn constraint because that would
389 * temporarily fail on the next UPDATE.
393 "set constraints pages_redirect_cn, sitemenu_url_cn deferred" in
396 (* Mark the old page as deleted. NB. There is a small race
397 * condition here because PostgreSQL doesn't do isolation
398 * properly. If a user tries to visit this page between the
399 * delete and the creation of the new page, then they'll get
400 * a page not found error. (XXX)
402 let sth = dbh#prepare_cached "update pages set url_deleted = url,
404 where hostid = ? and id = ?" in
405 sth#execute [`Int hostid; `Int model.id];
407 (* Get the IP address of the user, if available. *)
409 try `String (Connection.remote_ip (Request.connection r))
410 with Not_found -> `Null in
414 | User (id, _, _) -> `Int id
418 let redirect = if model.redirect = "" then `Null
419 else `String model.redirect in
421 (* Create the new page. *)
422 let sth = dbh#prepare_cached "insert into pages (hostid, url, title,
423 description, creation_date, logged_ip,
424 logged_user, redirect, css)
425 values (?, ?, ?, ?, ?, ?, ?, ?, ?)" in
426 sth#execute [`Int hostid; `String url; `String title;
427 `String model.description; creation_date; logged_ip;
428 logged_user; redirect; css];
430 (* New page ID <> old page ID model.id. *)
431 let pageid = sth#serial "pages_id_seq" in
433 (* Create the page contents. *)
434 let sth = dbh#prepare_cached "insert into contents (pageid,
435 ordering, sectionname, divname, content)
436 values (?, ?, ?, ?, ?)" in
437 let ordering = ref 0 in (* Creating new ordering. *)
438 List.iter (fun (sectionname, divname, content) ->
440 if string_is_whitespace divname then `Null
441 else `String divname in
443 if string_is_whitespace sectionname then `Null
444 else `String sectionname in
445 incr ordering; let ordering = !ordering in
446 sth#execute [`Int pageid; `Int ordering;
447 sectionname; divname;
451 (* Commit changes to the database. *)
454 (* Email notification, if anyone is listed for this host. *)
455 let subject = "Page " ^ url ^ " has been edited" in
458 (* Prepare the diff between this version and the previous version. *)
459 let diff, _ = get_diff dbh hostid url ~version:pageid () in
460 "Page: http://" ^ hostname ^ "/" ^ url ^ "\n\n" ^
463 email_notify ~body ~subject dbh hostid;
465 let buttons = [ ok_button ("/" ^ url) ] in
466 ok ~title:"Saved" ~buttons
467 q "The page was saved."
474 let sth = dbh#prepare_cached "select url from pages
475 where hostid = ? and id = ?" in
476 sth#execute [`Int hostid; `Int id];
477 let url = sth#fetch1string () in
479 q#redirect ("http://" ^ hostname ^ "/" ^ url)
482 (* This codes decides where we are in the current editing cycle.
485 * id - if set, then we are in the midst of editing a page.
486 * save - if set, then we want to save the page.
487 * cancel - if set, abandon changes and go back to viewing the page.
488 * action_* - one of the action buttons was set, eg. move up/down.
489 * page - the page URL opened newly for editing.
492 let id = int_of_string (q#param "id") in
493 if q#param_true "cancel" then (
497 if q#param_true "save" then (
498 let ok = try_save () in
499 if ok then raise CgiExit (* ... else fall through *)
501 continue_editing () (* Processes the action, if any. *)
504 let page = q#param "page" in
505 let page = if page = "" then "index" else page in
511 register_script ~restrict:[CanEdit] run