File: xtar.go

package info (click to toggle)
golang-github-likexian-gokit 0.24.7-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 720 kB
  • sloc: makefile: 5
file content (240 lines) | stat: -rw-r--r-- 4,461 bytes parent folder | download
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
/*
 * Copyright 2012-2021 Li Kexian
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * A toolkit for Golang development
 * https://www.likexian.com/
 */

package xtar

import (
	"archive/tar"
	"compress/gzip"
	"fmt"
	"io"
	"os"
	"strings"

	"github.com/likexian/gokit/xfile"
)

// Version returns package version
func Version() string {
	return "0.1.2"
}

// Author returns package author
func Author() string {
	return "[Li Kexian](https://www.likexian.com/)"
}

// License returns package license
func License() string {
	return "Licensed under the Apache License 2.0"
}

// Create compress a list of files
func Create(tarFile string, files ...string) (err error) {
	if xfile.Exists(tarFile) {
		err = fmt.Errorf("xtar: file name %s is exists", tarFile)
		return
	}

	if len(files) == 0 {
		err = fmt.Errorf("xtar: no input file specify")
		return
	}

	fd, err := xfile.New(tarFile)
	if err != nil {
		return
	}
	defer fd.Close()

	var tw *tar.Writer
	if IsGzName(tarFile) {
		gw := gzip.NewWriter(fd)
		defer gw.Close()

		tw = tar.NewWriter(gw)
		defer tw.Close()
	} else {
		tw = tar.NewWriter(fd)
		defer tw.Close()
	}

	for _, f := range files {
		err = addFile(tw, f, "")
		if err != nil {
			return
		}
	}

	return
}

// addFile do compress a file
func addFile(tw *tar.Writer, file string, prefix string) error {
	if prefix != "" && !strings.HasSuffix(prefix, "/") {
		prefix += "/"
	}

	fd, err := os.Open(file)
	if err != nil {
		return err
	}
	defer fd.Close()

	f, err := os.Lstat(file)
	if err != nil {
		return err
	}

	fl := ""
	if f.Mode()&os.ModeSymlink != 0 {
		fl, err = os.Readlink(file)
		if err != nil {
			return err
		}
	}

	h, err := tar.FileInfoHeader(f, fl)
	if err != nil {
		return err
	}

	h.Name = prefix + h.Name
	err = tw.WriteHeader(h)
	if err != nil {
		return err
	}

	switch mode := f.Mode(); {
	case mode.IsRegular():
		_, err = io.Copy(tw, fd)
		if err != nil {
			return err
		}
	case mode&os.ModeSymlink != 0:
	case mode.IsDir():
		prefix += f.Name()
		fs, err := fd.Readdir(0)
		if err != nil {
			return err
		}
		for _, ff := range fs {
			err = addFile(tw, fd.Name()+"/"+ff.Name(), prefix)
			if err != nil {
				return err
			}
		}
	default:
		return fmt.Errorf("xtar: unsupport file mode: %v", mode)
	}

	return nil
}

// Extract decompress a tar file to folder
func Extract(tarFile, dstFolder string) (err error) {
	if dstFolder != "" && !strings.HasSuffix(dstFolder, "/") {
		dstFolder += "/"
	}

	fd, err := os.Open(tarFile)
	if err != nil {
		return
	}
	defer fd.Close()

	var tr *tar.Reader
	if IsGzName(tarFile) {
		gr, err := gzip.NewReader(fd)
		if err != nil {
			return err
		}
		defer gr.Close()

		tr = tar.NewReader(gr)
	} else {
		tr = tar.NewReader(fd)
	}

	for {
		h, err := tr.Next()
		if err != nil {
			if err == io.EOF {
				break
			} else {
				return err
			}
		}
		fname := strings.TrimPrefix(h.Name, "/")
		if fname == "" {
			continue
		}
		dstFile := dstFolder + fname
		switch h.Typeflag {
		case tar.TypeReg:
			ffd, err := xfile.New(dstFile)
			if err != nil {
				return err
			}
			_, err = io.Copy(ffd, tr)
			if err != nil {
				return err
			}
			ffd.Close()
		case tar.TypeLink:
			err = os.Link(h.Linkname, dstFile)
			if err != nil {
				return err
			}
		case tar.TypeSymlink:
			err = os.Symlink(h.Linkname, dstFile)
			if err != nil {
				return err
			}
		case tar.TypeDir:
			if !xfile.Exists(dstFile) {
				err = os.MkdirAll(dstFile, 0755)
				if err != nil {
					return err
				}
			}
		default:
			return fmt.Errorf("xtar: unsupport file type: %v", h.Typeflag)
		}
		_ = os.Chtimes(dstFile, h.AccessTime, h.ModTime)
		_ = os.Chmod(dstFile, os.FileMode(h.Mode))
		_ = os.Chown(dstFile, h.Uid, h.Gid)
	}

	return
}

// IsGzName returns is a tar.gz file name
func IsGzName(name string) bool {
	name = strings.Trim(name, ".")
	if strings.HasSuffix(name, ".tgz") {
		return true
	}

	if strings.HasSuffix(name, ".tar.gz") {
		return true
	}

	return false
}