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.5 2005/11/24 14:54:15 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 : Dbi.connection) hostid filename =
  81   let template = _get_template filename in
  82
  83   if hostid > 0 then (
  84     (* Get standard fields concerning this host from the database. *)
  85     let sth =
  86       dbh#prepare_cached
  87         "select h.theme_css, p.name, p.url, h.search_box,
  88                 h.brand, h.brand_tagline, h.brand_description,
  89                 h.pagebug
  90            from hosts h left outer join powered_by p on h.powered_by = p.id
  91           where h.id = ?" in
  92     sth#execute [`Int hostid];
  93
  94     let theme_css, powered_by_name, powered_by_url, search_box,
  95       brand, brand_tagline, brand_description, pagebug =
  96       match sth#fetch1 () with
  97       | [ a; b; c; d; e; f; g; h] -> a, b, c, d, e, f, g, h
  98       | _ -> assert false in
  99
 100     let theme_css =
 101       match theme_css with
 102       | `Null -> "/_css/standard.css"
 103       | `String file -> file
 104       | _ -> assert false in
 105
 106     let powered_by_name, powered_by_url =
 107       match powered_by_name, powered_by_url with
 108       | `Null, `Null ->
 109           let url = "http://sandbox.merjis.com/" in
 110           let name = Cocanwiki_version.package ^ " " ^
 111                      Cocanwiki_version.version in
 112           name, url
 113       | `String name, `String url -> name, url
 114       | _ -> assert false in
 115
 116     let search_box = match search_box with `Bool b -> b | _ -> assert false in
 117
 118     let branding, brand,
 119       has_brand_tagline, brand_tagline,
 120       has_brand_description, brand_description =
 121       match brand with
 122       | `Null -> false, "", false, "", false, ""
 123       | `String brand ->
 124           let has_brand_tagline, brand_tagline =
 125             match brand_tagline with
 126             | `Null -> false, ""
 127             | `String s -> true, s
 128             | _ -> assert false in
 129           let has_brand_description, brand_description =
 130             match brand_description with
 131             | `Null -> false, ""
 132             | `String s -> true, s
 133             | _ -> assert false in
 134           true, brand,
 135           has_brand_tagline, brand_tagline,
 136           has_brand_description, brand_description
 137       | _ -> assert false in
 138
 139     let has_pagebug, pagebug =
 140       match pagebug with
 141       | `Null -> false, ""
 142       | `String pagebug -> true, pagebug
 143       | _ -> assert false in
 144
 145     template#set "theme_css" theme_css;
 146     template#set "powered_by_name" powered_by_name;
 147     template#set "powered_by_url" powered_by_url;
 148     template#conditional "search_box" search_box;
 149     template#conditional "branding" branding;
 150     template#set "brand" brand;
 151     template#conditional "has_brand_tagline" has_brand_tagline;
 152     template#set "brand_tagline" brand_tagline;
 153     template#conditional "has_brand_description" has_brand_description;
 154     template#set "brand_description" brand_description;
 155     template#conditional "has_pagebug" has_pagebug;
 156     template#set "pagebug" pagebug;
 157
 158     (* Site menu. *)
 159     let sth = dbh#prepare_cached "select url, label, ordering from sitemenu
 160                                    where hostid = ? order by ordering" in
 161     sth#execute [`Int hostid];
 162
 163     let is_homepage =
 164       match page with
 165       | None -> false
 166       | Some "index" -> true
 167       | _ -> false in
 168     template#conditional "is_homepage" is_homepage;
 169
 170     let table = sth#map (function [`String url; `String label; _] ->
 171                            let is_linked =
 172                              match page with
 173                              | None -> true
 174                              | Some page when page = url -> false
 175                              | _ -> true in
 176                            let id = id_of_url url in
 177                            [ "url", Template.VarString url;
 178                              "label", Template.VarString label;
 179                              "is_linked", Template.VarConditional is_linked;
 180                              "id", Template.VarString id ]
 181                          | _ -> assert false) in
 182
 183     template#table "sitemenu" table;
 184   )
 185   else (* if we have no hostid *) (
 186     template#set "theme_css" "/_css/standard.css";
 187     template#set "powered_by_name" (Cocanwiki_version.package ^ " " ^
 188                                     Cocanwiki_version.version);
 189     template#set "powered_by_url" "http://sandbox.merjis.com/";
 190     template#conditional "search_box" false;
 191     template#conditional "branding" false;
 192     template#set "brand" "";
 193     template#conditional "has_brand_tagline" false;
 194     template#set "brand_tagline" "";
 195     template#conditional "has_brand_description" false;
 196     template#set "brand_description" "";
 197     template#conditional "has_pagebug" false;
 198     template#set "pagebug" "";
 199     template#conditional "is_homepage" false;
 200     template#table "sitemenu" [];
 201   );
 202   (* Copyright year. *)
 203   template#set "year" (string_of_int year);
 204
 205   template