scripts/lib/cocanwiki_template.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: cocanwiki_template.ml,v 1.8 2006/08/03 13:53:00 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  * This module wraps around the Template library.  It provides caching
  22  * of templates and fills in standard fields on a host-specific basis.
  23  *
  24  *)
  25
  26 open Unix
  27
  28 open Cocanwiki_files
  29 open Cocanwiki_strings
  30
  31 (* This is used to generate the id fields from URLs on the site menu. *)
  32 let id_of_url str =
  33   let str = String.copy str in
  34   for i = 0 to String.length str - 1 do
  35     if not (isalnum str.[i]) then str.[i] <- '_'
  36   done;
  37   str
  38
  39 let base =
  40   let base =
  41     try Sys.getenv "COCANWIKI_TEMPLATES"
  42     with Not_found -> "/usr/share/cocanwiki/templates" in
  43   let is_dir path =
  44     try (Unix.stat path).Unix.st_kind = Unix.S_DIR
  45     with Unix.Unix_error _ -> false in
  46   if not (is_dir base) then
  47     failwith ("environment variable $COCANWIKI_TEMPLATES " ^
  48               "must be set to point to my 'templates' directory " ^
  49               "(see README file for more details)");
  50   base
  51
  52 (* The webserver gets restarted regularly enough that this is reasonable. *)
  53 let { tm_year = year } = gmtime (time ())
  54 let year = year + 1900
  55
  56 (* Cache of precompiled templates, arranged by full path. *)
  57 let cache = Hashtbl.create 32
  58
  59 let _get_template filename =
  60   let path = base // filename in
  61   let stat = Unix.stat path in
  62   let mtime = stat.st_mtime in
  63
  64   try
  65     let template, old_mtime = Hashtbl.find cache path in
  66     if old_mtime < mtime then (
  67       (* The template has changed on disk since it was compiled.  Reload. *)
  68       let template = Template.template path in
  69       Hashtbl.replace cache path (template, mtime);
  70       template
  71     ) else
  72       template
  73   with
  74       Not_found ->
  75         (* Template not seen before, so load it. *)
  76         let template = Template.template path in
  77         Hashtbl.replace cache path (template, mtime);
  78         template
  79
  80 let get_template ?page dbh hostid filename =
  81   let template = _get_template filename in
  82
  83   if hostid > 0l then (
  84     (* Get standard fields concerning this host from the database. *)
  85     let rows =
  86       PGSQL(dbh) "nullable-results"
  87         "select h.theme_css, h.css is not null,
  88                 p.name, p.url, h.search_box,
  89                 h.brand, h.brand_tagline, h.brand_description,
  90                 h.pagebug
  91            from hosts h left outer join powered_by p on h.powered_by = p.id
  92           where h.id = $hostid" in
  93
  94     let theme_css, has_host_css, powered_by_name, powered_by_url, search_box,
  95       brand, brand_tagline, brand_description, pagebug =
  96       match rows with
  97       | [ row ] -> row
  98       | _ -> assert false in
  99
 100     let theme_css =
 101       match theme_css with
 102       | None -> "/_css/standard.css"
 103       | Some file -> file in
 104
 105     let has_host_css =
 106       match has_host_css with
 107       | Some true -> true
 108       | _ -> false in
 109
 110     let powered_by_name, powered_by_url =
 111       match powered_by_name, powered_by_url with
 112       | None, None ->
 113           let url = "http://sandbox.merjis.com/" in
 114           let name = Cocanwiki_version.package ^ " " ^
 115                      Cocanwiki_version.version in
 116           name, url
 117       | Some name, Some url -> name, url
 118       | _ -> assert false in
 119
 120     let branding, brand,
 121       has_brand_tagline, brand_tagline,
 122       has_brand_description, brand_description =
 123       match brand with
 124       | None -> false, "", false, "", false, ""
 125       | Some brand ->
 126           let has_brand_tagline, brand_tagline =
 127             match brand_tagline with
 128             | None -> false, ""
 129             | Some s -> true, s in
 130           let has_brand_description, brand_description =
 131             match brand_description with
 132             | None -> false, ""
 133             | Some s -> true, s in
 134           true, brand,
 135           has_brand_tagline, brand_tagline,
 136           has_brand_description, brand_description in
 137
 138     let has_pagebug, pagebug =
 139       match pagebug with
 140       | None -> false, ""
 141       | Some pagebug -> true, pagebug in
 142
 143     let search_box = match search_box with Some b -> b | _ -> assert false in
 144
 145     template#set "theme_css" theme_css;
 146     template#conditional "has_host_css" has_host_css;
 147     template#set "powered_by_name" powered_by_name;
 148     template#set "powered_by_url" powered_by_url;
 149     template#conditional "search_box" search_box;
 150     template#conditional "branding" branding;
 151     template#set "brand" brand;
 152     template#conditional "has_brand_tagline" has_brand_tagline;
 153     template#set "brand_tagline" brand_tagline;
 154     template#conditional "has_brand_description" has_brand_description;
 155     template#set "brand_description" brand_description;
 156     template#conditional "has_pagebug" has_pagebug;
 157     template#set "pagebug" pagebug;
 158
 159     (* Site menu. *)
 160     let rows = PGSQL(dbh)
 161       "select url, label, ordering from sitemenu
 162         where hostid = $hostid order by ordering" in
 163
 164     let is_homepage =
 165       match page with
 166       | None -> false
 167       | Some "index" -> true
 168       | _ -> false in
 169     template#conditional "is_homepage" is_homepage;
 170
 171     let table = List.map
 172       (fun (url, label, _) ->
 173          let is_linked =
 174            match page with
 175            | None -> true
 176            | Some page when page = url -> false
 177            | _ -> true in
 178          let id = id_of_url url in
 179          [ "url", Template.VarString url;
 180            "label", Template.VarString label;
 181            "is_linked", Template.VarConditional is_linked;
 182            "id", Template.VarString id ]
 183       ) rows in
 184
 185     template#table "sitemenu" table;
 186   )
 187   else (* if we have no hostid *) (
 188     template#set "theme_css" "/_css/standard.css";
 189     template#conditional "has_host_css" false;
 190     template#set "powered_by_name" (Cocanwiki_version.package ^ " " ^
 191                                     Cocanwiki_version.version);
 192     template#set "powered_by_url" "http://sandbox.merjis.com/";
 193     template#conditional "search_box" false;
 194     template#conditional "branding" false;
 195     template#set "brand" "";
 196     template#conditional "has_brand_tagline" false;
 197     template#set "brand_tagline" "";
 198     template#conditional "has_brand_description" false;
 199     template#set "brand_description" "";
 200     template#conditional "has_pagebug" false;
 201     template#set "pagebug" "";
 202     template#conditional "is_homepage" false;
 203     template#table "sitemenu" [];
 204   );
 205   (* Copyright year. *)
 206   template#set "year" (string_of_int year);
 207
 208   template