Find orphan pages.
[cocanwiki.git] / scripts / orphans.ml
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: orphans.ml,v 1.1 2004/11/06 17:26:10 rich Exp $
5  *
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.
10  *
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.
15  *
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.
20  *)
21
22 open Apache
23 open Registry
24 open Cgi
25 open Printf
26
27 open Cocanwiki
28 open Cocanwiki_template
29
30 let run r (q : cgi) (dbh : Dbi.connection) hostid _ _ =
31   let template = get_template dbh hostid "orphans.html" in
32
33   (* Start with the front page, the contents of the site menu and the
34    * special "copyright" page.
35    *)
36   let sth = dbh#prepare_cached "select url from sitemenu where hostid = ?" in
37   sth#execute [`Int hostid];
38
39   let start_pages = sth#map (function [`String s] -> s | _ -> assert false) in
40   let start_pages = "index" :: "copyright" :: start_pages in
41
42   (* The find the list of orphans, we first construct the list of
43    * pages reachable from the front page.  Once this list has been
44    * constructed, any page not on the list is an orphan or part of
45    * a group of orphans.
46    *)
47   let rec loop pages border =
48     (* Preconditions:
49      * pages <> []
50      * border <> []
51      * pages is a list of distinct pages
52      * border is a list of distinct pages
53      * pages @ border is a list of distinct pages
54      *)
55     let pages' = pages @ border in
56     let qs = Dbi.placeholders (List.length border) in
57     let qs' = Dbi.placeholders (List.length pages') in
58     let sth =
59       dbh#prepare_cached ("select distinct to_url from links
60                             where hostid = ? and from_url in " ^ qs ^ "
61                               and to_url not in " ^ qs') in
62     sth#execute (`Int hostid ::
63                    (List.map (fun s -> `String s) border) @
64                    (List.map (fun s -> `String s) pages'));
65     let border' = sth#map (function [`String s] -> s | _ -> assert false) in
66
67     if border' = [] then pages'
68     else loop pages' border'
69   in
70   let non_orphans = loop [] start_pages in
71
72   (* Get the actual orphans, which are pages which do not appear in this list*)
73   let qs = Dbi.placeholders (List.length non_orphans) in
74   let sth = dbh#prepare_cached ("select url, title from pages
75                                   where hostid = ?
76                                     and url is not null
77                                     and redirect is null
78                                     and url not in " ^ qs ^ "
79                                   order by 1") in
80   sth#execute (`Int hostid :: (List.map (fun s -> `String s) non_orphans));
81
82   let table =
83     sth#map (function [`String page; `String title] ->
84                [ "page", Template.VarString page;
85                  "title", Template.VarString title ]
86                | _ -> assert false) in
87
88   template#table "pages" table;
89
90   q#template template
91
92 let () =
93   register_script ~restrict:[CanView] run