1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
(*
* Copyright (C) 2006-2009 Citrix Systems Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation; version 2.1 only. with the special
* exception on linking described in file LICENSE.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*)
(** Tar utilities *)
module Header : sig
(** Process and create tar file headers *)
(** Represents a standard (non-USTAR) archive (note checksum not stored) *)
type t = {
file_name : string;
file_mode: int;
user_id: int;
group_id: int;
file_size: int64;
mod_time: int64;
link: bool;
link_name: int;
}
(** Helper function to make a simple header *)
val make : ?file_mode:int -> ?user_id:int -> ?group_id:int -> ?mod_time:int64 -> ?link:bool -> ?link_name:int -> string -> int64 -> t
(** Length of a header block *)
val length : int
(** A blank header block (two of these in series mark the end of the tar) *)
val zero_block : string
(** Pretty-print the header record *)
val to_detailed_string : t -> string
(** Make a single line summary which looks like the output of tar -tv *)
val to_summary_string : t -> string
(** For debugging: pretty-print a string as hex *)
val to_hex : string -> string
(** Thrown when unmarshalling a header if the checksums don't match *)
exception Checksum_mismatch
(** Thrown if we detect the end of the tar (at least two zero blocks in sequence) *)
exception End_of_stream
(** Unmarshal a header block, returning None if it's all zeroes *)
val unmarshal : string -> t option
(** Marshal a header block, computing and inserting the checksum *)
val marshal : t -> string
(** Returns the next header block or throws End_of_stream if two consecutive
zero-filled blocks are discovered. Assumes stream is positioned at the
possible start of a header block. Unix.End_of_file is thrown if the stream
unexpectedly fails *)
val get_next_header : Unix.file_descr -> t
(** Compute the amount of zero-padding required to round up the file size
to a whole number of blocks *)
val compute_zero_padding_length : t -> int
(** Return the required zero-padding as a string *)
val zero_padding : t -> string
(** Return the header needed for a particular file on disk *)
val of_file : string -> t
end
val write_string : Unix.file_descr -> string -> unit
val write_bigbuffer : Unix.file_descr -> Bigbuffer.t -> unit
val write_block : Header.t -> (Unix.file_descr -> unit) -> Unix.file_descr -> unit
val write_end : Unix.file_descr -> unit
module Archive : sig
(** Utility functions for operating over whole tar archives *)
(** Skip 'n' bytes from input channel 'ifd' *)
val skip : Unix.file_descr -> int -> unit
(** Read the next header, apply the function 'f' to the fd and the header. The function
should leave the fd positioned immediately after the datablock. Finally the function
skips past the zero padding to the next header *)
val with_next_file : Unix.file_descr -> (Unix.file_descr -> Header.t -> 'a) -> 'a
(** Multicast 'n' bytes from input fd 'ifd' to output fds 'ofds'. NB if one deadlocks
they all stop.*)
val multicast_n : ?buffer_size:int -> Unix.file_descr -> Unix.file_descr list -> int64 -> unit
val multicast_n_string : string -> Unix.file_descr list -> int -> unit
(** Copy 'n' bytes from input fd 'ifd' to output fd 'ofd' *)
val copy_n : Unix.file_descr -> Unix.file_descr -> int64 -> unit
(** List the contents of a tar to stdout *)
val list : Unix.file_descr -> unit
(** Extract the contents of a tar to directory 'dest' *)
val extract : string -> Unix.file_descr -> unit
(** Create a tar on file descriptor fd from the filename list 'files' *)
val create : string list -> Unix.file_descr -> unit
end
|
