matitaB/matita/matitaAuthentication.ml

   1 (* Copyright (C) 2004-2011, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 type session_id = Uuidm.t
  27
  28 type matita_file = MatitaFilesystem.matita_flag * string
  29
  30 (* user table: user id, (password, optional session id) *)
  31 type user = string * (string * session_id option)
  32
  33 let user_tbl = (ref [] : user list ref)
  34
  35 (* session table: session id, (user id, matita status, matita history *)
  36 type session = session_id * (string * MatitaEngine.status * MatitaEngine.status list)
  37
  38 let session_tbl = (ref [] : session list ref)
  39
  40 exception UsernameCollision of string
  41
  42 let lookup_user uid = List.assoc uid !user_tbl
  43
  44 let user_of_session sid = let res,_,_ = List.assoc sid !session_tbl in res
  45
  46 let get_users () = List.map fst !user_tbl
  47
  48 let create_session uid =
  49   let status = new MatitaEngine.status (Some uid) "cic:/matita" in
  50   let history = [status] in
  51   let pw,sid = List.assoc uid !user_tbl in
  52   let clean_utbl = List.remove_assoc uid !user_tbl in
  53   let new_session = Uuidm.create `V4 in
  54   user_tbl := (uid,(pw,Some new_session))::clean_utbl;
  55   let clean_stbl = match sid with
  56     | Some sid' ->
  57        List.remove_assoc sid' !session_tbl
  58     | _ -> !session_tbl
  59   in
  60   session_tbl := (new_session,(uid,status,history))::clean_stbl;
  61   new_session
  62 ;;
  63
  64 let get_session_owner sid =
  65   let uid,_,_ = List.assoc sid !session_tbl
  66   in uid
  67
  68 let get_status sid =
  69   let _,st,_ = List.assoc sid !session_tbl
  70   in st
  71
  72 let get_history sid =
  73   let _,_,hist = List.assoc sid !session_tbl
  74   in hist
  75
  76 let set_status sid st =
  77   let uid, oldst, hist = List.assoc sid !session_tbl in
  78   session_tbl := (sid,(uid,st,hist))::(List.remove_assoc sid !session_tbl)
  79
  80 let set_history sid hist =
  81   let uid, st, oldhist = List.assoc sid !session_tbl in
  82   session_tbl := (sid,(uid,st,hist))::(List.remove_assoc sid !session_tbl)
  83
  84 let logout_user sid =
  85   let uid,st,hist = List.assoc sid !session_tbl in
  86   let pw,_ = List.assoc uid !user_tbl in
  87   user_tbl := (uid,(pw,None))::List.remove_assoc uid !user_tbl;
  88   session_tbl := List.remove_assoc sid !session_tbl
  89 ;;
  90
  91 let remove_user uid =
  92   user_tbl := List.remove_assoc uid !user_tbl
  93 ;;
  94
  95 (* serialization and deserialization of the user table *)
  96 let config_path () =
  97   let path = Helm_registry.get "matita.basedir" in
  98   let dirname = Filename.dirname path in
  99   HExtlib.mkdir dirname;
 100   path
 101 ;;
 102
 103 let serialize () =
 104   let clean_utbl = List.map (fun (uid,(pw,_)) -> uid,(pw,None)) !user_tbl in
 105   let utbl_ch = open_out (config_path () ^ "/usertable.dump") in
 106   Marshal.to_channel utbl_ch clean_utbl [];
 107   close_out utbl_ch;
 108 ;;
 109
 110 let deserialize () =
 111   (try
 112     let utbl_ch = open_in (config_path () ^ "/usertable.dump") in
 113     user_tbl := Marshal.from_channel utbl_ch;
 114     close_in utbl_ch;
 115   with
 116     | Sys_error _ ->
 117        user_tbl := []; serialize());
 118   (* old_sessions are now invalid *)
 119   session_tbl := [];
 120 ;;
 121
 122 let write_ft uid ft =
 123   let ft_ch = open_out (config_path () ^ "/ft_" ^ uid ^ ".dump") in
 124   Marshal.to_channel ft_ch ft [];
 125   close_out ft_ch;
 126 ;;
 127
 128 let read_ft uid =
 129   try
 130     let ft_ch = open_in (config_path () ^ "/ft_" ^ uid ^ ".dump") in
 131     let ft = Marshal.from_channel ft_ch in
 132     close_in ft_ch;
 133     ft
 134   with
 135     | Sys_error _ ->
 136       (* this is an error, we should rebuild the table by a diff of
 137          the directory listing and svn stat *)
 138       []
 139 ;;
 140
 141 let set_file_flag uid files_flags =
 142   let ft = read_ft uid in
 143   let files = List.map fst files_flags in
 144   let ft = List.filter (fun (x,_) -> not (List.mem x files)) ft in
 145   let ft' = List.fold_left (fun acc (filename,flag) ->
 146       let filename = MatitaFilesystem.normalize_qfn filename in
 147       try
 148         (filename,HExtlib.unopt flag)::acc
 149       with Failure _ -> acc) [] files_flags
 150   in
 151   write_ft uid (ft'@ft)
 152 ;;
 153
 154 let add_user uid pw =
 155   try
 156     let _ = lookup_user uid in
 157     raise (UsernameCollision uid)
 158   with Not_found ->
 159     let ft = MatitaFilesystem.checkout uid in
 160     user_tbl := (uid,(pw,None))::!user_tbl;
 161     write_ft uid ft;
 162     serialize ()
 163 ;;
 164
 165 let reset () =
 166   user_tbl := [];
 167   session_tbl := [];
 168   MatitaFilesystem.reset_lib ();
 169   serialize ();
 170 ;;