85e9dd93848db98caf437e78206ceda6419a8625
[carnet-tools-cn.git] / functions.sh
1 # by ddzeko & ico, Fri, 18 Mar 2005 14:44:08 +0100
2 cp_get_ifaddr() {
3   [ "$CP_SCRIPT_DEBUG" ] && set -vx
4   local ifaddr interface echo_return
5   echo_return="$CP_ECHO_RETURN" # since we're making our own calls
6   # in our own way we need to set CP_ECHO_RETURN the way we want it
7   # but preserving initial state so it could be used afterwards
8   CP_ECHO_RETURN=""
9
10   interface="$1"
11   if [ -z "$interface" ]; then
12     cp_get_ifdefault dev
13     interface="$RET"
14     [ -z "$interface" ] && interface=lo
15   fi
16
17   if ! ifconfig $interface 2> /dev/null >> /dev/null; then
18     echo "cp_get_ifaddr: $interface: No such interface" 1>&2
19     CP_ECHO_RETURN="$echo_return"
20     return 2
21   fi
22
23   ifaddr="`/sbin/ifconfig $interface | awk '/inet/{ printf("%s\n",substr($2,index($2,":")+1)) }'`"
24
25   if [ -z $ifaddr ]; then
26     echo "cp_get_ifaddr: $interface: No ip address found" 1>&2
27     CP_ECHO_RETURN="$echo_return"
28     return 1
29   fi
30
31   RET="$ifaddr"
32   [ -z "$echo_return" ] || echo $RET
33   CP_ECHO_RETURN="$echo_return"
34 }
35
36 # by ddzeko & ico, Fri, 18 Mar 2005 14:44:08 +0100
37 cp_get_ifmask() {
38   [ "$CP_SCRIPT_DEBUG" ] && set -vx
39   local ifmask interface echo_return
40   echo_return="$CP_ECHO_RETURN" # since we're making our own calls
41   # in our own way we need to set CP_ECHO_RETURN the way we want it
42   # but preserving initial state so it could be used afterwards
43   CP_ECHO_RETURN=""
44
45   interface="$1"
46   if [ -z "$interface" ]; then
47     cp_get_ifdefault dev
48     interface="$RET"
49     [ -z "$interface" ] && interface=lo
50   fi
51
52   if ! ifconfig $interface 2> /dev/null >> /dev/null; then
53     echo "cp_get_ifmask: $interface: No such interface" 1>&2
54     CP_ECHO_RETURN="$echo_return"
55     return 1
56   fi
57
58   ifmask="`/sbin/ifconfig $interface | awk '/Mask/{if($3~/Mask/)a=$3;else if ($4~/Mask/)a=$4;printf ("%s\n", substr(a,index(a,":")+1))}'`"
59
60   if [ -z "$ifmask" ]; then
61     echo "cp_get_ifmask: $interface: No netmask found" 1>&2
62     CP_ECHO_RETURN="$echo_return"
63     return 1
64   fi
65
66   RET="$ifmask"
67   [ -z "$echo_return" ] || echo $RET
68   CP_ECHO_RETURN="$echo_return"
69 }
70
71 # by ddzeko, Mon, 21 Mar 2005 07:00:22 +0100
72 cp_get_ifdefault() {
73   local echo_return
74   echo_return="$CP_ECHO_RETURN" # since we're making our own calls
75   # in our own way we need to set CP_ECHO_RETURN the way we want it
76   # but preserving initial state so it could be used afterwards
77   CP_ECHO_RETURN=""
78
79   [ "$CP_SCRIPT_DEBUG" ] && set -vx
80   RET=""
81   case $1 in
82     dev)  RET=`route -n | awk '/^0.0.0.0/{print $8}'` ;;
83     addr) RET=`route -n | awk '/^0.0.0.0/{print $2}'` ;;
84     *)    echo "cp_get_ifdefault: Argument required (dev or addr)" >&2 ;;
85   esac
86   [ -z "$RET" -a "$1" ] && echo "cp_get_ifdefault: No default route" >&2
87   [ -z "$echo_return" ] || echo $RET
88   CP_ECHO_RETURN="$echo_return"
89   [ -z "$RET" ] && return 1
90 }
91
92 # by ico, Tue, 15 Mar 2005 14:04:21 +0100
93 cp_get_netaddr() {
94   [ "$CP_SCRIPT_DEBUG" ] && set -vx
95   local netmask ipaddress interface cidr echo_return
96   echo_return="$CP_ECHO_RETURN" # since we're making our own calls
97   # in our own way we need to set CP_ECHO_RETURN the way we want it
98   # but preserving initial state so it could be used afterwards
99   CP_ECHO_RETURN=""
100
101   interface="$1"
102   if [ -z "$interface" ]; then
103     cp_get_ifdefault dev
104     interface="$RET"
105     [ -z "$interface" ] && interface=lo
106   fi
107
108   if ! ifconfig $interface 2> /dev/null >> /dev/null; then
109     echo "cp_get_netaddr: $interface: No such interface" 1>&2
110     CP_ECHO_RETURN="$echo_return"
111     return 1
112   fi
113
114   cp_get_ifaddr "$interface"
115   ipaddress="$RET"
116   if [ -z $ipaddress ]; then
117     echo "cp_get_netaddr: $interface: No IP address found" 1>&2
118     CP_ECHO_RETURN="$echo_return"
119     return 1
120   fi
121   cp_get_ifmask "$interface"
122   netmask="$RET"
123   if [ -z $netmask ]; then
124     echo "cp_get_netaddr: $interface: No netmask found" 1>&2
125     CP_ECHO_RETURN="$echo_return"
126     return 1
127   fi
128
129   if [ "$netmask" = "255.255.255.255" ]; then
130     cidr="$ipaddress/32"
131   else 
132     cidr="`ipcalc -ncb $ipaddress $netmask | awk '/^Network:/{print $2}'`"
133   fi
134   
135   RET="$cidr"
136   [ -z "$echo_return" ] || echo $RET
137   CP_ECHO_RETURN="$echo_return"
138 }
139
140 cp_check_and_backup() {
141   cp_backup_conffile -r "$@"
142 }
143
144 # by ico, Tue, 15 Mar 2005 14:04:21 +0100
145 cp_backup_conffile() {
146   [ "$CP_SCRIPT_DEBUG" ] && set -vx
147   local file_bak check did
148   
149   if [ "x$1" = "x-r" ]; then
150     check=1
151     shift
152   fi
153   if [ -z "$1" ]; then
154     return 1
155   fi
156   if [ ! -f "$1" ]; then
157     echo "cp_backup_conffile: $1: No such file" 1>&2
158     return 2
159   fi
160   if [ -z "$2" ]; then
161     file_bak="/var/backups/`basename $1`.bak"
162   else
163     file_bak="/var/backups/`basename $2`.bak"
164   fi
165
166   if [ ! -f "$file_bak" ]; then
167     cp -pf "$1" "$file_bak"
168     did=1
169   else
170     if ! cmp -s "$1" "$file_bak"; then
171       /usr/bin/savelog -p -c 7 "$file_bak" > /dev/null 2> /dev/null
172       cp -pf "$1" "$file_bak"
173       did=1
174     fi
175   fi
176   
177   if [ "$check" -a "$did" ]; then
178     return 0
179   else
180     return 3
181   fi
182 }
183
184 # by jelly, Tue, 15 Mar 2005 14:04:21 +0100
185 # modified by ico, Mon,  6 Jun 2005 11:58:08 +0200
186 # A sed wrapper, to use instead of perl -pi -e
187 #  - relatively safe in-place s///g
188 #  - takes care of symlinks and ownership
189 # returns true if changed, false if nothing happened
190 #
191 cp_check_and_sed() {
192   [ "$CP_SCRIPT_DEBUG" ] && set -vx
193   local s sedcmd grepret ret i
194   s="$1"
195   shift
196   sedcmd="$1"
197   shift
198   ret=2
199   for i in "$@"
200   do
201     [ -e "$i" ]        || continue
202     if ! egrep -q "$s" "$i"; then
203       grepret=1
204       continue
205     fi
206     [ -h "$i" ]        && i=$(readlink -f "$i")
207     sed "$sedcmd" "$i" > "$i.dpkg-tmp"
208     if [ ! "$?" = "0" ]; then
209       rm "$i.dpkg-tmp"
210       echo "cp_check_and_sed: Problem with sed" 1>&2
211       return 5
212     fi
213     if ! cmp -s "$i" "$i.dpkg-tmp" 2>&1 >/dev/null; then
214       cp_mv "$i.dpkg-tmp" "$i"
215     else
216       rm "$i.dpkg-tmp"
217     fi
218     ret=0
219   done
220   [ "$ret" -eq 2 -a "$grepret"] && ret=1 || true
221   return $ret
222 }
223
224 # by jelly, Sun, 20 Mar 2005 20:12:19 +0100
225 cp_echo () {
226   [ "$CP_SCRIPT_DEBUG" ] && set -vx
227   if [ "x$1" = "x-mailonly" -o "x$1" = "x-m" ]; then
228     shift
229   else   
230     echo "$*"
231   fi
232   CP_NOTICE="$CP_NOTICE$1"
233   if [ `echo -n "$*" | wc -l` -eq 0 ]; then
234     CP_NOTICE="$CP_NOTICE
235 "
236   fi
237 }   
238
239 # by jelly, Sun, 20 Mar 2005 20:12:19 +0100
240 cp_mail () {
241   [ "$CP_SCRIPT_DEBUG" ] && set -vx
242   local pkg version quiet
243   if [ "x$1" = "x-q" ]; then
244     quiet=1
245     shift
246   fi
247   [ -n "$1" ] && pkg="$1"       # barf if no package
248   [ -n "$2" ] && version=" $2" || true
249   if [ "$(echo $CP_NOTICE|wc -w)" -gt 0 ]; then
250     [ -n "$quiet" ] || echo "Mailing upgrade output to root."
251     CP_NOTICE="From: $pkg postinst script <root>
252 To: root
253 Subject: $pkg$version package install log
254 Date: $(/bin/date +'%a, %d %b %Y %H:%M:%S %z')
255  
256 Hello!
257
258 The $pkg package has been successfully installed on your computer.
259 For your convenience, a partial output of the last $pkg installation
260 is included below.
261
262 ----------
263 ${CP_NOTICE}----------"
264   
265     echo "$CP_NOTICE" | /usr/sbin/sendmail -t &
266     sleep 1
267   fi
268 }
269
270 # by ddzeko, Mon, 21 Mar 2005 11:31:59 +0100
271 cp_mv () {
272   [ "$CP_SCRIPT_DEBUG" ] && set -vx
273   local new old
274   if [ -z "$2" ]; then
275     return 1
276   fi
277   new="$1"
278   old="$2"
279   if [ -e "$old" ]; then
280     chown --reference "$old" "$new"
281     chmod --reference "$old" "$new"
282   fi
283   mv "$new" "$old"
284 }
285
286 # by ddzeko, Mon, 21 Mar 2005 13:35:42 +0100
287 cp_yes_no () {
288   [ "$CP_SCRIPT_DEBUG" ] && set -vx
289   local prompt answer
290   prompt="$1"
291   [ "$prompt" ] || prompt="Are you sure?"
292   RET=""
293
294   # check to prevent user from using this when debconf is active
295   # (it would break communication with its backend - uses stdin/out)
296   if [ "$DEBCONF_REDIR" ]; then
297     echo "cp_yes_no: debconf redirection detected" >&2
298     return 1
299   fi
300
301   echo -n "$prompt (y)es/(n)o: "
302   read answer
303   case "$answer" in
304     y*)
305       echo
306       RET=y
307       ;;
308     n*)
309       echo
310       RET=n
311       ;;
312     *)
313       echo
314       echo "Please read the message and choose y or n"
315       cp_yes_no
316       ;;
317   esac
318 }
319
320 # by ddzeko, Tue, 29 Mar 2005 17:37:52 +0200
321 #
322 # db_get seems to return error messages if the requested variable 
323 # is not found - we do not find that desirable, and checking $? with
324 # set -e turned on seems to be a bit of a problem
325 # --> that's why we wrap the db_get call to return unset RET variable
326 #     instead of some gibberish error message that our script does
327 #     not expect
328 cp_db_get() {
329   local var
330   var="$1"
331   
332   # check to prevent user from using this before activating debconf
333   # confmodule needs to be loaded before accessing db_* functions
334   if [ -z "$DEBCONF_REDIR" ]; then
335     echo "cp_db_get: debconf not activated!" >&2
336     return 1
337   fi
338  
339   if ! db_get "$var"; then
340     case "$RET" in
341         *doesn\'t\ exist)
342           RET=""
343           ;;
344         [0-9][0-9]\ ?*) # other errors
345           RET=""
346           ;;
347     esac
348   fi
349 }
350
351 # by ico, Wed, 20 Apr 2005 21:09:54 +0200
352 cp_get_ldap_suffix() {
353   local echo_return
354   echo_return="$CP_ECHO_RETURN" # since we're making our own calls
355   # in our own way we need to set CP_ECHO_RETURN the way we want it
356   # but preserving initial state so it could be used afterwards
357   CP_ECHO_RETURN=""
358
359   [ "$CP_SCRIPT_DEBUG" ] && set -vx
360
361   if [ ! -f /etc/ldap/slapd.conf ]; then
362     echo "cp_get_ldap_suffix: /etc/ldap/slapd.conf: No such file" >&2
363     return 2
364   fi
365   
366   RET="`awk  '/^suffix/      { exit }
367               END            { gsub(/"/, "", $2); print $2 }' \
368              < /etc/ldap/slapd.conf`"
369
370   if [ "`echo $RET | sed 's/,/ /g' | wc -w`" -gt 2 ]; then
371     RET=""
372     echo "cp_get_ldap_suffix: Invalid LDAP suffix in /etc/ldap/slapd.conf" >&2
373     return 2
374   fi
375     
376   [ -z "$RET" ] && echo "cp_get_ldap_suffix: No LDAP suffix in /etc/ldap/slapd.conf" >&2
377   [ -z "$echo_return" ] || echo $RET
378   CP_ECHO_RETURN="$echo_return"
379 }
380
381 # by ico, Wed, 20 Apr 2005 21:09:54 +0200
382 cp_get_ldap_realm() {
383   local echo_return
384   echo_return="$CP_ECHO_RETURN" # since we're making our own calls
385   # in our own way we need to set CP_ECHO_RETURN the way we want it
386   # but preserving initial state so it could be used afterwards
387   CP_ECHO_RETURN=""
388
389   [ "$CP_SCRIPT_DEBUG" ] && set -vx
390
391   if [ ! -f /etc/ldap/slapd.conf ]; then
392     echo "cp_get_ldap_realm: /etc/ldap/slapd.conf: No such file" >&2
393     return 2
394   fi
395  
396   cp_get_ldap_suffix || true
397   RET="`echo $RET | awk -F, '{print $1}' | awk -F= '{print $2}'`"
398
399   [ -z "$RET" ] && echo "cp_get_ldap_realm: No LDAP REALM in /etc/ldap/slapd.conf" >&2
400   [ -z "$echo_return" ] || echo $RET
401   CP_ECHO_RETURN="$echo_return"
402 }
403