components/hbugs/hbugs_id_generator.ml

   1 (*
   2  * Copyright (C) 2003:
   3  *    Stefano Zacchiroli <zack@cs.unibo.it>
   4  *    for the HELM Team http://helm.cs.unibo.it/
   5  *
   6  *  This file is part of HELM, an Hypertextual, Electronic
   7  *  Library of Mathematics, developed at the Computer Science
   8  *  Department, University of Bologna, Italy.
   9  *
  10  *  HELM is free software; you can redistribute it and/or
  11  *  modify it under the terms of the GNU General Public License
  12  *  as published by the Free Software Foundation; either version 2
  13  *  of the License, or (at your option) any later version.
  14  *
  15  *  HELM is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with HELM; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  23  *  MA  02111-1307, USA.
  24  *
  25  *  For details, see the HELM World-Wide-Web page,
  26  *  http://helm.cs.unibo.it/
  27  *)
  28
  29 (* $Id$ *)
  30
  31 let _ = Random.self_init ()
  32
  33 let id_length = 32
  34 let min_ascii = 33
  35 let max_ascii = 126
  36   (* characters forbidden inside an XML attribute value. Well, '>' and '''
  37   aren't really forbidden, but are listed here ... just to be sure *)
  38 let forbidden_chars = (* i.e. [ '"'; '&'; '\''; '<'; '>' ] *)
  39   [ 34; 38; 39; 60; 62 ]  (* assumption: is sorted! *)
  40 let chars_range = max_ascii - min_ascii + 1 - (List.length forbidden_chars)
  41
  42   (* return a random id char c such that
  43       (min_ascii <= Char.code c) &&
  44       (Char.code c <= max_ascii) &&
  45       (not (List.mem (Char.code c) forbidden_chars))
  46   *)
  47 let random_id_char () =
  48   let rec nth_char ascii shifts = function
  49     | [] -> Char.chr (ascii + shifts)
  50     | hd::tl when ascii + shifts < hd -> Char.chr (ascii + shifts)
  51     | hd::tl (* when ascii + shifts >= hd *) -> nth_char ascii (shifts + 1) tl
  52   in
  53   nth_char (Random.int chars_range + min_ascii) 0 forbidden_chars
  54
  55   (* return a random id string which have length id_length *)
  56 let new_id () =
  57   let str = String.create id_length in
  58   for i = 0 to id_length - 1 do
  59     String.set str i (random_id_char ())
  60   done;
  61   str
  62
  63 let new_broker_id = new_id
  64 let new_client_id = new_id
  65 let new_musing_id = new_id
  66 let new_tutor_id = new_id
  67