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: page.ml,v 1.32 2004/10/10 19:19:58 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.
31 open Cocanwiki_template
34 open Cocanwiki_server_settings
37 type fp_status = FPOK of int * string * string * Dbi.datetime * bool
38 | FPRedirect of string
41 (* Referer strings which help us decide if the user came from
42 * a search engine and highlight terms in the page appropriately.
44 let search_engines = [
45 Pcre.regexp "^http://.*google\\.", [ "q"; "as_q"; "as_epq"; "as_oq" ];
46 Pcre.regexp "^http://.*yahoo\\.", [ "p" ];
47 Pcre.regexp "^http://.*msn\\.", [ "q"; "MT" ]
49 let split_words = Pcre.regexp "\\W+"
51 let split_qs_re = Pcre.regexp "\\?"
53 let xhtml_re = Pcre.regexp "<.*?>|[^<>]+"
55 let run r (q : cgi) (dbh : Dbi.connection) hostid
56 ({ edit_anon = edit_anon;
57 view_anon = view_anon } as host)
59 let template_page = get_template dbh hostid "page.html" in
60 let template_404 = get_template dbh hostid "page_404.html" in
62 let page = q#param "page" in
63 let page = if page = "" then "index" else page in
65 (* Host-specific fields. *)
66 let sth = dbh#prepare_cached "select css is not null,
67 feedback_email is not null,
68 mailing_list, search_box, navigation
69 from hosts where id = ?" in
70 sth#execute [`Int hostid];
71 let has_host_css, has_feedback_email, mailing_list, search_box, navigation =
72 match sth#fetch1 () with
73 | [ `Bool has_host_css; `Bool has_feedback_email; `Bool mailing_list;
74 `Bool search_box; `Bool navigation ] ->
75 has_host_css, has_feedback_email, mailing_list, search_box,
77 | _ -> assert false in
79 (* Can the user edit? Manage users? etc. *)
80 let can_edit = can_edit host user in
81 let can_manage_users = can_manage_users host user in
82 let can_manage_contacts = can_manage_contacts host user in
83 let can_manage_site = can_manage_site host user in
84 let can_edit_global_css = can_edit_global_css host user in
86 (* Do we have a stats page set up? *)
87 let has_stats = server_settings_stats_page dbh <> None in
89 (* Given the referer string, return the list of search terms. If none
90 * can be found, then throws Not_found.
92 let search_terms_from_referer referer =
94 List.find (fun (rex, _) -> Pcre.pmatch ~rex referer) search_engines in
96 match Pcre.split ~rex:split_qs_re ~max:2 referer with
97 | [url] | [url;""] -> url, ""
99 | _ -> assert false in
100 let args = Cgi_args.parse qs in
102 List.find (fun argname -> List.mem_assoc argname args) argnames in
103 let search_string = List.assoc argname args in
104 Pcre.split ~rex:split_words search_string
107 (* Given a full page of XHTML, highlight search terms found in the
108 * <body> part of the page.
110 let highlight_search_terms xhtml search_terms span_class =
111 (* Split the original XHTML into strings and tags. For example if
112 * the original string is: "This is some <b>bold</b> text.<br/>", then
113 * after this step we will have the following list:
114 * [ "This is some "; "<b>"; "bold"; "</b>"; " text."; "<br/>" ]
116 let xhtml = Pcre.extract_all ~rex:xhtml_re xhtml in
117 let xhtml = Array.to_list xhtml in
118 let xhtml = List.map (fun matches -> matches.(0)) xhtml in
120 (* Find the <body> ... </body> tags. We only want to apply
121 * highlighting to tags within this area.
123 let rec list_split f acc = function
124 | [] -> List.rev acc, []
125 | ((x :: _) as xs) when f x -> List.rev acc, xs
127 let acc = x :: acc in
131 list_split (fun str -> String.starts_with str "<body") [] xhtml in
133 list_split ((=) "</body>") [] body in
134 (* NB: Hopefully, xhtml = head @ body @ tail. *)
136 (* The search terms are a list of simple words. Turn into a big
137 * regular expression, because we want to substitute for each. We
138 * end up with a regexp like '(word1|word2|word3)'.
141 Pcre.regexp ~flags:[`CASELESS]
142 ("(" ^ String.concat "|" search_terms ^ ")") in
144 (* Do the substitution, but only on text, not elements! *)
147 "<span class=\"" ^ span_class ^ "\">" ^ text ^ "</span>"
150 if String.length str > 0 && str.[0] != '<' then
151 Pcre.substitute ~rex ~subst str
155 (* Join the XHTML fragments back together again. *)
156 String.concat "" (List.concat [ head ; body ; tail ])
159 (* Check the templates table for extensions. *)
160 let get_extension url =
161 let sth = dbh#prepare_cached "select extension from templates
165 sth#execute [`String url];
168 let name = sth#fetch1string () in
169 Some (List.assoc name !extensions)
174 (* This code generates ordinary pages. *)
175 let make_page title description pageid last_modified_date has_page_css
176 version page page' extension =
177 let t = template_page in
179 t#set "last_modified_date" last_modified_date;
181 (match description with
182 None -> t#conditional "has_description" false
183 | Some description ->
184 t#conditional "has_description" true;
185 t#set "description" description);
187 if page <> page' then (* redirection *) (
189 t#set "original_page" page; (* XXX title - get it from database *)
190 t#conditional "redirected" true
193 t#conditional "redirected" false
196 t#conditional "has_host_css" has_host_css;
197 t#conditional "has_page_css" has_page_css;
199 t#conditional "has_feedback_email" has_feedback_email;
200 t#conditional "mailing_list" mailing_list;
201 t#conditional "search_box" search_box;
202 t#conditional "navigation" navigation;
204 t#conditional "can_edit" can_edit;
205 t#conditional "can_manage_users" can_manage_users;
206 t#conditional "can_manage_contacts" can_manage_contacts;
207 t#conditional "can_manage_site" can_manage_site;
208 t#conditional "can_edit_global_css" can_edit_global_css;
210 t#conditional "has_stats" has_stats;
212 (* Pull out the sections in this page. *)
217 let sth = dbh#prepare_cached
218 "select ordering, sectionname, content, divname
219 from contents where pageid = ? order by ordering" in
220 sth#execute [`Int pageid];
223 (function [`Int ordering;
224 (`Null | `String _) as sectionname;
226 (`Null | `String _) as divname] ->
227 let divname, has_divname =
230 | `String divname -> divname, true in
231 let sectionname, has_sectionname =
232 match sectionname with
234 | `String sectionname -> sectionname, true in
235 let linkname = linkname_of_sectionname sectionname in
236 [ "ordering", Template.VarString (string_of_int ordering);
238 Template.VarConditional has_sectionname;
239 "sectionname", Template.VarString sectionname;
240 "linkname", Template.VarString linkname;
243 (Wikilib.xhtml_of_content dbh hostid content);
244 "has_divname", Template.VarConditional has_divname;
245 "divname", Template.VarString divname ]
246 | _ -> assert false) in
248 (* Call an extension to generate the first section in this page? *)
253 let content = extension dbh hostid page' in
255 "ordering", Template.VarString "0";
256 "has_sectionname", Template.VarConditional false;
257 "linkname", Template.VarString "";
258 "content", Template.VarString content;
259 "has_divname", Template.VarConditional true;
260 "divname", Template.VarString "form_div";
262 section :: sections in
264 t#table "sections" sections;
266 (* Are we showing an old version of the page? If so, warn. *)
269 t#conditional "is_old_version" false
271 t#conditional "is_old_version" true;
272 t#set "old_version" (string_of_int pageid));
277 t#conditional "user_logged_in" false
278 | User (_, username, _) ->
279 t#conditional "user_logged_in" true;
280 t#set "username" username);
282 (* If logged in, we want to update the recently_visited table. *)
283 if pageid <> None then (
285 | User (userid, _, _) ->
286 let sth = dbh#prepare_cached "delete from recently_visited
287 where hostid = ? and userid = ?
289 sth#execute [`Int hostid; `Int userid; `String page'];
290 let sth = dbh#prepare_cached
291 "insert into recently_visited (hostid, userid, url)
293 sth#execute [`Int hostid; `Int userid; `String page'];
298 (* Navigation links. *)
300 let max_links = 18 in (* Show no more links than this. *)
302 (* What links here. *)
303 let wlh = what_links_here dbh hostid page' in
304 let wlh = List.take max_links wlh in
305 let wlh_urls = List.map fst wlh in (* Just the URLs ... *)
309 | User (userid, _, _) ->
310 (* Recently visited URLs, but don't repeat any from the 'what
311 * links here' section, and don't link to self.
313 let not_urls = page' :: wlh_urls in
314 let limit = max_links - List.length wlh_urls in
315 let qs = Dbi.placeholders (List.length not_urls) in
318 ("select rv.url, p.title, rv.visit_time
319 from recently_visited rv, pages p
320 where rv.hostid = ? and rv.userid = ?
321 and rv.url not in " ^ qs ^ "
322 and rv.hostid = p.hostid and rv.url = p.url
325 let args = List.map (fun s -> `String s) not_urls in
327 ([`Int hostid; `Int userid] @ args @ [`Int limit]);
329 (function [`String url; `String title; _] ->
335 let f (page, title) = [ "page", Template.VarString page;
336 "title", Template.VarString title ] in
337 let table = List.map f wlh in
338 t#table "what_links_here" table;
339 t#conditional "has_what_links_here" (wlh <> []);
341 let table = List.map f rv in
342 t#table "recently_visited" table;
343 t#conditional "has_recently_visited" (rv <> []);
345 (* If both lists are empty (ie. an empty navigation box would
346 * appear), then disable navigation altogether.
348 if wlh = [] && rv = [] then t#conditional "navigation" false
351 (* If we are coming from a search engine then we want to highlight
352 * search terms throughout the whole page ...
355 let referer = Table.get (Request.headers_in r) "Referer" in
356 let search_terms = search_terms_from_referer referer in
358 (* Highlight the search terms. *)
359 let xhtml = t#to_string in
360 let xhtml = highlight_search_terms xhtml search_terms "search_term" in
362 (* Deliver the page. *)
367 (* No referer / no search terms / not a search engine referer. *)
371 (* This code generates 404 pages. *)
373 Request.set_status r 404; (* Return a 404 error code. *)
375 let t = template_404 in
381 ('a'..'z' | 'A'..'Z' | '0'..'9') as c -> c
384 t#set "search_terms" search_terms;
386 t#conditional "has_host_css" has_host_css;
388 t#conditional "can_edit" can_edit;
389 t#conditional "can_manage_users" can_manage_users;
390 t#conditional "can_manage_contacts" can_manage_contacts;
391 t#conditional "can_manage_site" can_manage_site;
392 t#conditional "can_edit_global_css" can_edit_global_css;
394 t#conditional "has_stats" has_stats;
399 (* Fetch a page by name. This function can give three answers:
400 * (1) Page fetched OK (fetches some details of the page).
401 * (2) Page is a redirect (fetches the name of the redirect page).
402 * (3) Page not found in database, could be template or 404 error.
404 (* XXX Should do a case-insensitive matching of URLs, and if the URL differs
405 * in case only should redirect to the lowercase version.
407 let fetch_page page version allow_redirect =
410 if allow_redirect then (
413 "select redirect, id, title, description, last_modified_date,
415 from pages where hostid = ? and url = ?" in
416 sth#execute [`Int hostid; `String page];
418 (match sth#fetch1 () with
419 | [ `Null; `Int id; `String title; `String description;
420 `Timestamp last_modified_date; `Bool has_page_css ] ->
421 FPOK (id, title, description, last_modified_date,
423 | `String redirect :: _ ->
427 Not_found -> FPNotFound)
428 ) else (* redirects not allowed ... *) (
431 "select id, title, description, last_modified_date,
433 from pages where hostid = ? and url = ?" in
434 sth#execute [`Int hostid; `String page];
436 (match sth#fetch1 () with
437 | [ `Int id; `String title; `String description;
438 `Timestamp last_modified_date; `Bool has_page_css ] ->
439 FPOK (id, title, description, last_modified_date,
443 Not_found -> FPNotFound)
448 "select id, title, description, last_modified_date,
451 where hostid = ? and id = ? and
452 (url = ? or url_deleted = ?)" in
453 sth#execute [`Int hostid; `Int version;
454 `String page; `String page];
456 (match sth#fetch1 () with
457 | [ `Int id; `String title; `String description;
458 `Timestamp last_modified_date; `Bool has_page_css ] ->
459 FPOK (id, title, description, last_modified_date,
463 Not_found -> FPNotFound)
466 (* Here we deal with the complex business of redirects and versions. *)
467 (* Only allow the no_redirect and version syntax for editors. *)
468 let allow_redirect, version =
470 not (q#param_true "no_redirect"),
471 try Some (int_of_string (q#param "version")) with Not_found -> None
475 let rec loop page' i =
476 if i > max_redirect then (
477 error ~title:"Too many redirections" ~back_button:true
478 q ("Too many redirects between pages. This may happen because " ^
479 "of a cycle of redirections.");
482 match fetch_page page' version allow_redirect with
483 | FPOK (pageid, title, description, last_modified_date, has_page_css)->
484 (* Check if the page is also a template. *)
485 let extension = get_extension page' in
486 make_page title (Some description) (Some pageid)
487 (printable_date last_modified_date) has_page_css
488 version page page' extension
489 | FPRedirect page' ->
492 (* Might be a templated page with no content in it. *)
493 let extension = get_extension page' in
494 (match extension with
495 | (Some _) as extension ->
497 make_page title None None
498 "Now" false None page page'
506 register_script ~restrict:[CanView] run