utils/Spacefile.sh at master · space-sh/utils · GitHub

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
#
# Copyright 2016-2017 Blockie AB
#
# 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.
#

#================================
# UTILS_DEP_INSTALL
#
# Do nothing, but conform to the
# /_dep_install/ pattern.
#
#================================
UTILS_DEP_INSTALL()
{
    SPACE_DEP="PRINT"
    PRINT "No particular dependencies." "ok"
}


# Disable warning about local keyword
# shellcheck disable=2039

#================================
# UTILS_WAITFORFILE
#
# Wait for one or more files or directories.
# Optionally using timeout.
#
# Parameters:
#   $1: list of file paths
#   $2: timeout in seconds (optional)
#
# Returns:
#   0: success
#   1: time out
#
#================================
UTILS_WAITFORFILE()
{
    SPACE_SIGNATURE="files:0 [timeout]"
    SPACE_DEP="PRINT"

    local filelist="${1}"
    shift

    local timeout="${1-}"
    shift $(( $# > 0 ? 1 : 0 ))

    PRINT "Wait for files: ${filelist}, timeout: ${timeout}." "debug"

    local timeoutc="-1"
    local file=''
    for file in ${filelist}; do
        PRINT "Waiting for file/dir: ${file}." "debug"
        while :; do
            if [ ! -e "${file}" ]; then
                if [ -n "${timeout}" ]; then
                    timeoutc=$((timeoutc+1))
                    if [ "${timeoutc}" -ge "${timeout}" ]; then
                        PRINT "Wait for files timeouted after ${timeoutc} seconds." "info"
                        return 1
                    fi
                fi
                sleep 1
                continue  # Wait for the same file.
            fi
            break  # Wait for the next file.
        done
        PRINT "Found file: ${file}." "debug"
    done
}


# Disable warning about local keyword
# shellcheck disable=2039

#================================
# UTILS_SLEEP
#
# Sleep for number of seconds or indefinitely.
#
# Parameters:
#   $1: timeout in seconds. Empty means sleep forever.
#
# Returns:
#   Non-zero on error.
#
#================================
UTILS_SLEEP()
{
    # shellcheck disable=2034
    SPACE_SIGNATURE="[seconds]"
    # shellcheck disable=2034
    SPACE_DEP="PRINT"

    local duration="${1-}"
    shift $(( $# > 0 ? 1 : 0 ))

    if [ -z "${duration}" ]; then
        # Sleep forever
        PRINT "Sleep forever ..." "debug"
        tail -f /dev/null
    else
        PRINT "Sleep for ${duration} seconds ..." "debug"
        sleep "${duration}"
    fi
}