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.3 2006/03/27 18:09:46 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 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 [Some hostid];
  38
  39   let start_pages = sth#map (function [Some 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    * XXX This does not properly handle redirects XXX
  48    *)
  49   let rec loop pages border =
  50     (* Preconditions:
  51      * pages <> []
  52      * border <> []
  53      * pages is a list of distinct pages
  54      * border is a list of distinct pages
  55      * pages @ border is a list of distinct pages
  56      *)
  57     let pages' = pages @ border in
  58     let qs = Dbi.placeholders (List.length border) in
  59     let qs' = Dbi.placeholders (List.length pages') in
  60     let sth =
  61       dbh#prepare_cached ("select distinct to_url from links
  62                             where hostid = ? and from_url in " ^ qs ^ "
  63                               and to_url not in " ^ qs') in
  64     sth#execute (Some hostid ::
  65                    (List.map (fun s -> Some s) border) @
  66                    (List.map (fun s -> Some s) pages'));
  67     let border' = sth#map (function [Some s] -> s | _ -> assert false) in
  68
  69     if border' = [] then pages'
  70     else loop pages' border'
  71   in
  72   let non_orphans = loop [] start_pages in
  73
  74   (* Get the actual orphans, which are pages which do not appear in this list*)
  75   let qs = Dbi.placeholders (List.length non_orphans) in
  76   let sth = dbh#prepare_cached ("select url, title from pages
  77                                   where hostid = ?
  78                                     and url is not null
  79                                     and redirect is null
  80                                     and url not in " ^ qs ^ "
  81                                   order by 1") in
  82   sth#execute (Some hostid :: (List.map (fun s -> Some s) non_orphans));
  83
  84   let table =
  85     sth#map (function [Some page; Some title] ->
  86                [ "page", Template.VarString page;
  87                  "title", Template.VarString title ]
  88                | _ -> assert false) in
  89
  90   template#table "pages" table;
  91
  92   q#template template
  93
  94 let () =
  95   register_script ~restrict:[CanView] run