helm/http_getter/http_getter_misc.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 open Http_getter_debugger;;
  30 open Printf;;
  31
  32 let trailing_dot_gz_RE = Pcre.regexp "\\.gz$"   (* for g{,un}zip *)
  33 let url_RE = Pcre.regexp "^([\\w.]+)(:(\\d+))?(/.*)?$"
  34 let http_scheme_RE = Pcre.regexp ~flags:[`CASELESS] "^http://"
  35 let file_scheme_RE = Pcre.regexp ~flags:[`CASELESS] "^file://"
  36 let dir_sep_RE = Pcre.regexp "/"
  37 let heading_slash_RE = Pcre.regexp "^/"
  38
  39 let bufsiz = 16384  (* for file system I/O *)
  40 let tcp_bufsiz = 4096 (* for TCP I/O *)
  41
  42 let fold_file f init fname =
  43   let inchan = open_in fname in
  44   let rec fold_lines' value =
  45     try
  46       let line = input_line inchan in
  47       fold_lines' (f value line)
  48     with End_of_file -> value
  49   in
  50   let res = (try fold_lines' init with e -> (close_in inchan; raise e)) in
  51   close_in inchan;
  52   res
  53 let iter_file f = fold_file (fun _ line -> f line) ()
  54
  55 let hashtbl_sorted_fold f tbl init =
  56   let sorted_keys =
  57     List.sort compare (Hashtbl.fold (fun key _ keys -> key::keys) tbl [])
  58   in
  59   List.fold_left (fun acc k -> f k (Hashtbl.find tbl k) acc) init sorted_keys
  60
  61 let cp src dst =
  62   let (ic, oc) = (open_in src, open_out dst) in
  63   let buf = String.create bufsiz in
  64   (try
  65     while true do
  66       let bytes = input ic buf 0 bufsiz in
  67       if bytes = 0 then raise End_of_file else output oc buf 0 bytes
  68     done
  69   with End_of_file -> ());
  70   close_in ic; close_out oc
  71
  72 let parse_url url =
  73   try
  74     let subs =
  75       Pcre.extract ~rex:url_RE (Pcre.replace ~rex:http_scheme_RE url)
  76     in
  77     (subs.(1),
  78     (if subs.(2) = "" then 80 else int_of_string subs.(3)),
  79     (if subs.(4) = "" then "/" else subs.(4)))
  80   with exc ->
  81     failwith
  82       (sprintf "Can't parse url: %s (exception: %s)"
  83         url (Printexc.to_string exc))
  84 let init_socket addr port =
  85   let inet_addr = (Unix.gethostbyname addr).Unix.h_addr_list.(0) in
  86   let sockaddr = Unix.ADDR_INET (inet_addr, port) in
  87   let suck = Unix.socket Unix.PF_INET Unix.SOCK_STREAM 0 in
  88   Unix.connect suck sockaddr;
  89   let outchan = Unix.out_channel_of_descr suck in
  90   let inchan = Unix.in_channel_of_descr suck in
  91   (inchan, outchan)
  92 let http_get_iter_buf ~callback url =
  93   let (address, port, path) = parse_url url in
  94   let buf = String.create tcp_bufsiz in
  95   let (inchan, outchan) = init_socket address port in
  96   output_string outchan (sprintf "GET %s\r\n" path);
  97   flush outchan;
  98   (try
  99     while true do
 100       match input inchan buf 0 tcp_bufsiz with
 101       | 0 -> raise End_of_file
 102       | bytes when bytes = tcp_bufsiz ->  (* buffer full, no need to slice it *)
 103           callback buf
 104       | bytes when bytes < tcp_bufsiz ->  (* buffer not full, slice it *)
 105           callback (String.sub buf 0 bytes)
 106       | _ -> (* ( bytes < 0 ) || ( bytes > tcp_bufsiz ) *)
 107           assert false
 108     done
 109   with End_of_file -> ());
 110   close_in inchan (* close also outchan, same fd *)
 111
 112 let wget ?output url =
 113   debug_print
 114     (sprintf "wgetting %s (output: %s)" url
 115       (match output with None -> "default" | Some f -> f));
 116   match url with
 117   | url when Pcre.pmatch ~rex:file_scheme_RE url -> (* file:// *)
 118       (let src_fname = Pcre.replace ~rex:file_scheme_RE url in
 119       match output with
 120       | Some dst_fname -> cp src_fname dst_fname
 121       | None ->
 122           let dst_fname = Filename.basename src_fname in
 123           if src_fname <> dst_fname then
 124             cp src_fname dst_fname
 125           else  (* src and dst are the same: do nothing *)
 126             ())
 127   | url when Pcre.pmatch ~rex:http_scheme_RE url -> (* http:// *)
 128       (let oc =
 129         open_out (match output with Some f -> f | None -> Filename.basename url)
 130       in
 131       http_get_iter_buf ~callback:(fun data -> output_string oc data) url;
 132       close_out oc)
 133   | scheme -> (* unsupported scheme *)
 134       failwith ("Http_getter_misc.wget: unsupported scheme: " ^ scheme)
 135
 136 let gzip ?(keep = false) ?output fname =
 137   let output = match output with None -> fname ^ ".gz" | Some fname -> fname in
 138   debug_print (sprintf "gzipping %s (keep: %b, output: %s)" fname keep output);
 139   let (ic, oc) = (open_in fname, Gzip.open_out output) in
 140   let buf = String.create bufsiz in
 141   (try
 142     while true do
 143       let bytes = input ic buf 0 bufsiz in
 144       if bytes = 0 then raise End_of_file else Gzip.output oc buf 0 bytes
 145     done
 146   with End_of_file -> ());
 147   close_in ic; Gzip.close_out oc;
 148   if not keep then Sys.remove fname
 149 ;;
 150
 151 let gunzip ?(keep = false) ?output fname =
 152     (* assumption: given file name ends with ".gz" or output is set *)
 153   let output =
 154     match output with
 155     | None ->
 156         if (Pcre.pmatch ~rex:trailing_dot_gz_RE fname) then
 157           Pcre.replace ~rex:trailing_dot_gz_RE fname
 158         else
 159           failwith
 160             "Http_getter_misc.gunzip: unable to determine output file name"
 161     | Some fname -> fname
 162   in
 163   debug_print (sprintf "gunzipping %s (keep: %b, output: %s)"
 164     fname keep output);
 165   let (ic, oc) = (Gzip.open_in fname, open_out output) in
 166   let buf = String.create bufsiz in
 167   (try
 168     while true do
 169       let bytes = Gzip.input ic buf 0 bufsiz in
 170       if bytes = 0 then raise End_of_file else Pervasives.output oc buf 0 bytes
 171     done
 172   with End_of_file -> ());
 173   Gzip.close_in ic; close_out oc;
 174   if not keep then Sys.remove fname
 175 ;;
 176
 177 let tempfile () = Filename.temp_file "http_getter_" ""
 178
 179 exception Mkdir_failure of string * string;;  (* dirname, failure reason *)
 180 let dir_perm = 0o755
 181
 182 let mkdir ?(parents = false) dirname =
 183   let mkdirhier () =
 184     let (pieces, hd) =
 185       let split = Pcre.split ~rex:dir_sep_RE dirname in
 186       if Pcre.pmatch ~rex:heading_slash_RE dirname then
 187         (List.tl split, "/")
 188       else
 189         (split, "")
 190     in
 191     ignore
 192       (List.fold_left
 193         (fun pre dir ->
 194           let next_dir =
 195             sprintf "%s%s%s" pre (match pre with "/" | "" -> "" | _ -> "/") dir
 196           in
 197           (try
 198             (match (Unix.stat next_dir).Unix.st_kind with
 199             | Unix.S_DIR -> ()  (* dir component already exists, go on! *)
 200             | _ ->  (* dir component already exists but isn't a dir, abort! *)
 201                 raise
 202                   (Mkdir_failure (dirname,
 203                     sprintf "'%s' already exists but is not a dir" next_dir)))
 204           with Unix.Unix_error (Unix.ENOENT, "stat", _) ->
 205             (* dir component doesn't exists, create it and go on! *)
 206             Unix.mkdir next_dir dir_perm);
 207           next_dir)
 208         hd pieces)
 209   in
 210   if parents then mkdirhier () else Unix.mkdir dirname dir_perm
 211
 212 let string_of_proc_status = function
 213   | Unix.WEXITED code -> sprintf "[Exited: %d]" code
 214   | Unix.WSIGNALED sg -> sprintf "[Killed: %d]" sg
 215   | Unix.WSTOPPED sg -> sprintf "[Stopped: %d]" sg
 216
 217 let http_get url =
 218   if Pcre.pmatch ~rex:file_scheme_RE url then begin
 219       (* file:// URL. Read data from file system *)
 220     let fname = Pcre.replace ~rex:file_scheme_RE url in
 221     try
 222       let size = (Unix.stat fname).Unix.st_size in
 223       let buf = String.create size in
 224       let ic = open_in fname in
 225       really_input ic buf 0 size;
 226       close_in ic;
 227       Some buf
 228     with Unix.Unix_error (Unix.ENOENT, "stat", _) -> None
 229   end else  (* other URL, pass it to netclient *)
 230     try
 231       Some (Http_client.Convenience.http_get url)
 232     with Http_client.Http_error (code, _) -> None
 233