aboutsummaryrefslogtreecommitdiff
path: root/files
blob: 85640e77cc7753de54097ed62e4752489a43e1a5 (plain)
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
#!/usr/bin/env bash
#
# files - functions acting on files.
#
# Copyright 2015 - 2019 Einhard Leichtfuß
#
# This file is part of rsync-backup.
#
# rsync-backup is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# rsync-backup 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with rsync-backup.  If not, see <https://www.gnu.org/licenses/>.
#


# Create directory, unless it exists already.  Returns non-zero, if the
# named file exists however is not a directory.
#
# $1: directory: path
#
function create_dir
{
	local dir="$1"

	if [[ ! -e "$dir" && ! -L "$dir" ]]
	then
		mkdir "$dir" || return $RET_ERROR
	elif [[ ! -d "$dir" || -L "$dir" ]]
	then
		error "\"$dir\" is not a directory."
		return $RET_FILE_ERR
	fi

	return $RET_SUCCESS
}


# Create a new directory, assuring it did not exist before.
#
# $1: directory: path
#
function create_new_dir
{
	local dir="$1"

	if [[ -e "$dir" || -L "$dir" ]]
	then
		error "\"$dir\" exists already."
		return $RET_FILE_ERR
	fi

	mkdir "$dir" || return $RET_ERROR

	return $RET_SUCCESS
}


# Verify the specified file is a directory.
#
# $1: directory: path
#
function assert_is_dir
{
	local dir="$1"

	if [[ ! -d "$dir" || -L "$dir" ]]
	then
		error "\"$dir\" is not a directory."
		return $RET_FILE_ERR
	fi

	return $RET_SUCCESS
}


# Replace symbolic link $2 by symbolic link $1.  $2 may not exist.
#
# $1: source file name: path
# $2: target file name: path
#
function replace_symlink
{
	local src="$1"
	local tgt="$2"

	if [[ ! -L "$src" ]]
	then
		error "\"$src\" is not a symbolic link."
		return $RET_FILE_ERR
	fi

	if [[ ! -L "$tgt" && -e "$tgt" ]]
	then
		error "\"$tgt\" is not a symbolic link."
		return $RET_FILE_ERR
	fi

	mv -T "$src" "$tgt" || return $RET_ERROR

	return $RET_SUCCESS
}


# Replace symbolic link $1's target by $2.  $1 may not exist.
#
# $1: link file: path
# $2: link target: path
#
function replace_symlink_target
{
	local link="$1"
	local tgt="$2"

	if [[ ! -L "$link" && -e "$link" ]]
	then
		error "\"$link\" is not a symbolic link."
		return $RET_FILE_ERR
	fi

	ln -sfT "$tgt" "$link" || return $RET_ERROR

	return $RET_SUCCESS
}


# Remove a symbolic link.
#
# $1: link: path
#
function remove_symlink
{
	local file="$1"

	if [[ ! -L "$file" ]]
	then
		error "\"$file\" is not a symbolic link."
		return $RET_FILE_ERR
	fi

	rm "$file" || return $RET_ERROR

	return $RET_SUCCESS
}

# vi: ft=bash ts=2 sw=2 noet