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_ext_calendar.ml,v 1.4 2006/07/26 13:12:11 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
31 open Cocanwiki_strings
34 let day_template = _get_template "calendar_day.html"
35 let month_template = _get_template "calendar_month.html"
36 let year_template = _get_template "calendar_year.html"
37 let year_1m_template = _get_template "calendar_year_1m.html"
39 (* Check a date is valid. *)
40 let check_date (y, m, d) =
42 let t = Date.make y m d in
44 && Date.int_of_month (Date.month t) = m
45 && Date.day_of_month t = d
47 Date.Out_of_bounds | Date.Undefined -> false
55 let extension dbh hostid url =
56 (* Validate a date in the form "yyyy[/mm[/dd]]". Returns a (yyyy, mm, dd)
57 * tuple with missing fields set to 0. If the string doesn't parse or the
58 * date isn't valid, then raises Not_found.
61 if String.length str = 4 &&
62 isdigit str.[0] && isdigit str.[1] &&
63 isdigit str.[2] && isdigit str.[3] then (
64 let yyyy = int_of_string (String.sub str 0 4) in
67 else if String.length str = 7 &&
68 isdigit str.[0] && isdigit str.[1] &&
69 isdigit str.[2] && isdigit str.[3] &&
71 isdigit str.[5] && isdigit str.[6] then (
72 let yyyy = int_of_string (String.sub str 0 4) in
73 let mm = int_of_string (String.sub str 5 2) in
74 if mm >= 1 && mm <= 12 then (yyyy, mm, 0) else raise Not_found
76 else if String.length str = 10 &&
77 isdigit str.[0] && isdigit str.[1] &&
78 isdigit str.[2] && isdigit str.[3] &&
80 isdigit str.[5] && isdigit str.[6] &&
82 isdigit str.[8] && isdigit str.[9] then (
83 let yyyy = int_of_string (String.sub str 0 4) in
84 let mm = int_of_string (String.sub str 5 2) in
85 let dd = int_of_string (String.sub str 8 2) in
86 let date = (yyyy, mm, dd) in
87 if check_date date then date else raise Not_found
93 (* From the links table, find all links to this page, or sub-calendar pages.
94 * This query overselects. We then filter the real pages in OCaml.
97 let patt = url ^ "%" in
99 "select li.from_url, p.title, li.to_url
100 from links li, pages p
101 where li.hostid = $hostid and li.to_url like $patt
102 and li.hostid = p.hostid and li.from_url = p.url" in
106 List.map (fun (from_url, title, to_url) ->
107 from_url, title, to_url) rows in
109 (fun (from_url, title, to_url) ->
110 try let date = valid_date to_url in Some (date, (title, from_url))
111 with Not_found -> None) results in
112 let pages = List.sort pages in
114 (* Validate the date in the URL itself. *)
116 try Some (valid_date url)
117 with Not_found -> None in
120 | None -> (* Not a valid date. *)
121 "<p>" ^ url ^ " is not an actual date.</p>"
122 | Some (yyyy, 0, 0) -> (* Year view. *)
123 let template = year_template in
125 template#set "yyyy" (string_of_int yyyy);
126 template#set "prev_yyyy" (string_of_int (yyyy - 1));
127 template#set "next_yyyy" (string_of_int (yyyy + 1));
129 (* Return true if there are any events on a particular day. *)
130 let has_events date = List.exists (fun (d, _) -> date = d) pages in
132 let int_of_day_of_week = function
133 | Date.Sun -> 0 | Date.Mon -> 1 | Date.Tue -> 2
134 | Date.Wed -> 3 | Date.Thu -> 4 | Date.Fri -> 5
138 (* Generate each month template separately ...
139 * Wow, finally found a place I can use a for loop.
143 let template = year_1m_template in
144 template#set "yyyy" (string_of_int yyyy);
145 template#set "mm" (sprintf "%02d" mm);
146 template#set "month_name"
147 (!Printer.month_name (Date.month_of_int mm));
148 let dow = Date.day_of_week (Date.make yyyy mm 1) in
149 let max_dd = Date.days_in_month (Date.make yyyy mm 1) in
150 let dd = ref (1 - int_of_day_of_week dow) in
152 for r = 0 to 5 do (* up to 5 rows ... *)
154 for c = 0 to 6 do (* 7 columns, Sunday - Saturday *)
155 let is_day = !dd >= 1 && !dd <= max_dd in
159 match Date.day_of_week (Date.make yyyy mm !dd) with
160 Date.Sat | Date.Sun -> true | _ -> false in
161 let date = yyyy, mm, !dd in
162 let events = has_events date in
163 (if is_weekend then "cal_year_1m_weekend " else "") ^
164 (if events then "cal_year_1m_events" else "")
166 "cal_year_1m_empty" in
168 [ "is_day", Template.VarConditional is_day;
169 "dd", Template.VarString (sprintf "%02d" !dd);
170 "class", Template.VarString clasz ] in
171 cols := col :: !cols;
174 rows := [ "cols", Template.VarTable (List.rev !cols) ] :: !rows;
178 template#table "rows" (List.rev !rows);
180 template#to_string in
181 template#set ("month" ^ string_of_int mm) str
186 List.filter (function ((_, 0, 0), _) -> true | _ -> false) pages in
189 List.map (fun (_, (title, page)) ->
190 [ "title", Template.VarString title;
191 "page", Template.VarString page ]) events in
192 template#table "events" table;
196 | Some (yyyy, mm, 0) -> (* Month view. *)
197 let template = month_template in
199 template#set "month_name" (!Printer.month_name (Date.month_of_int mm));
200 template#set "yyyy" (string_of_int yyyy);
201 template#set "mm" (sprintf "%02d" mm);
203 let prev_yyyy, prev_mm =
204 if mm = 1 then yyyy - 1, 12
206 let next_yyyy, next_mm =
207 if mm = 12 then yyyy + 1, 1
209 template#set "prev_yyyy" (string_of_int prev_yyyy);
210 template#set "prev_mm" (sprintf "%02d" prev_mm);
211 template#set "next_yyyy" (string_of_int next_yyyy);
212 template#set "next_mm" (sprintf "%02d" next_mm);
214 (* Get all monthly events and all daily events. *)
215 let monthly_events, daily_events =
216 List.partition (function ((_, _, 0), _) -> true | _ -> false)
219 (* Table of monthly events. *)
221 List.map (fun (_, (title, page)) ->
222 [ "title", Template.VarString title;
223 "page", Template.VarString page ]) monthly_events in
224 template#table "monthly_events" table;
226 (* How many days in this month? *)
227 let max_dd = Date.days_in_month (Date.make yyyy mm 1) in
228 let days = range 1 max_dd in
233 List.filter (fun ((_, _, d), _) -> d = dd)
236 List.map (fun (_, (title, page)) ->
237 [ "title", Template.VarString title;
238 "page", Template.VarString page ])
241 match Date.day_of_week (Date.make yyyy mm dd) with
242 Date.Sat | Date.Sun -> true | _ -> false in
243 [ "dd", Template.VarString (sprintf "%02d" dd);
244 "is_weekend", Template.VarConditional is_weekend;
245 "events", Template.VarTable table ])
247 template#table "days" table;
251 | Some (yyyy, mm, dd) -> (* Single day view. *)
252 let template = day_template in
254 (* XXX This will change once we start doing date and time events.
255 * For now it is very simple indeed.
257 template#set "yyyy" (string_of_int yyyy);
258 template#set "mm" (sprintf "%02d" mm);
259 template#set "dd" (sprintf "%02d" dd);
261 template#set "month_name" (!Printer.month_name (Date.month_of_int mm));
263 let t = Date.make yyyy mm dd in
264 let dow = Date.day_of_week t in
265 template#set "short_weekday" (Printer.short_name_of_day dow);
267 let oneday = Date.Period.day 1 in
268 let prev_t = Date.rem t oneday in
269 let next_t = Date.add t oneday in
270 let prev_yyyy, prev_mm, prev_dd =
271 Date.year prev_t, Date.int_of_month (Date.month prev_t),
272 Date.day_of_month prev_t in
273 let next_yyyy, next_mm, next_dd =
274 Date.year next_t, Date.int_of_month (Date.month next_t),
275 Date.day_of_month next_t in
277 template#set "prev_yyyy" (string_of_int prev_yyyy);
278 template#set "prev_mm" (sprintf "%02d" prev_mm);
279 template#set "prev_dd" (sprintf "%02d" prev_dd);
280 template#set "next_yyyy" (string_of_int next_yyyy);
281 template#set "next_mm" (sprintf "%02d" next_mm);
282 template#set "next_dd" (sprintf "%02d" next_dd);
284 let table = List.map (fun (_, (title, page)) ->
285 [ "title", Template.VarString title;
286 "page", Template.VarString page ]) pages in
287 template#table "events" table;
291 (* Register the extension. *)
293 extensions := ("calendar", extension) :: !extensions