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.1 2004/10/21 11:42:05 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   (* Get standard fields concerning this host from the database. *)
  84   let sth = dbh#prepare_cached "select theme_css from hosts
  85                                  where id = ?" in
  86   sth#execute [`Int hostid];
  87
  88   let theme_css =
  89     match sth#fetch1 () with
  90         [ `Null ] -> "/_css/standard.css"
  91       | [ `String file ] -> file
  92       | _ -> assert false in
  93
  94   template#set "theme_css" theme_css;
  95
  96   (* Site menu. *)
  97   let sth = dbh#prepare_cached "select url, label, ordering from sitemenu
  98                                  where hostid = ? order by ordering" in
  99   sth#execute [`Int hostid];
 100
 101   let is_homepage =
 102     match page with
 103       | None -> false
 104       | Some "index" -> true
 105       | _ -> false in
 106   template#conditional "is_homepage" is_homepage;
 107
 108   let table = sth#map (function [`String url; `String label; _] ->
 109                          let is_linked =
 110                            match page with
 111                              | None -> true
 112                              | Some page when page = url -> false
 113                              | _ -> true in
 114                          let id = id_of_url url in
 115                          [ "url", Template.VarString url;
 116                            "label", Template.VarString label;
 117                            "is_linked", Template.VarConditional is_linked;
 118                            "id", Template.VarString id ]
 119                          | _ -> assert false) in
 120
 121   template#table "sitemenu" table;
 122
 123   (* Wiki version. *)
 124   template#set "cocanwiki_package" Cocanwiki_version.package;
 125   template#set "cocanwiki_version" Cocanwiki_version.version;
 126
 127   (* Copyright year. *)
 128   template#set "year" (string_of_int year);
 129
 130   template