19116f8e5ec0bb66f6e509e89e63e58d7e6ae4b2
[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 # by ico, Tue, 15 Mar 2005 14:04:21 +0100
141 cp_backup_conffile() {
142   cp_check_and_backup "$@"
143 }
144
145 cp_check_and_backup() {
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 # A sed wrapper, to use instead of perl -pi -e
186 #  - relatively safe in-place s///g
187 #  - takes care of symlinks and ownership
188 # returns true if changed, false if nothing happened
189 #
190 cp_check_and_sed() {
191   [ "$CP_SCRIPT_DEBUG" ] && set -vx
192   local s sedcmd grepret ret i
193   s="$1"
194   shift
195   sedcmd="$1"
196   shift
197   ret=2
198   for i in "$@"
199   do
200     [ -e "$i" ]        || continue
201     if ! egrep -q "$s" "$i"; then
202       grepret=1
203       continue
204     fi
205     [ -h "$i" ]        && i=$(readlink -f "$i")
206     sed "$sedcmd" "$i" > "$i.dpkg-tmp"
207     if ! cmp -s "$i" "$i.dpkg-tmp" 2>&1 >/dev/null; then
208       cp_mv "$i.dpkg-tmp" "$i"
209     else
210       rm "$i.dpkg-tmp"
211     fi
212     ret=0
213   done
214   [ "$ret" -eq 2 -a "$grepret"] && ret=1 || true
215   return $ret
216 }
217
218 # by jelly, Sun, 20 Mar 2005 20:12:19 +0100
219 cp_echo () {
220   [ "$CP_SCRIPT_DEBUG" ] && set -vx
221   if [ "x$1" = "x-mailonly" -o "x$1" = "x-m" ]; then
222     shift
223   else   
224     echo "$*"
225   fi
226   CP_NOTICE="$CP_NOTICE$1"
227   if [ `echo -n "$*" | wc -l` -eq 0 ]; then
228     CP_NOTICE="$CP_NOTICE
229 "
230   fi
231 }   
232
233 # by jelly, Sun, 20 Mar 2005 20:12:19 +0100
234 cp_mail () {
235   [ "$CP_SCRIPT_DEBUG" ] && set -vx
236   local pkg version quiet
237   if [ "x$1" = "x-q" ]; then
238     quiet=1
239     shift
240   fi
241   [ -n "$1" ] && pkg="$1"       # barf if no package
242   [ -n "$2" ] && version=" $2" || true
243   if [ "$(echo $CP_NOTICE|wc -w)" -gt 0 ]; then
244     [ -n "$quiet" ] || echo "Mailing upgrade output to root."
245     CP_NOTICE="From: $pkg postinst script <root>
246 To: root
247 Subject: $pkg$version package install log
248 Date: $(/bin/date +'%a, %d %b %Y %H:%M:%S %z')
249  
250 Hello!
251
252 The $pkg package has been successfully installed on your computer.
253 For your convenience, a partial output of the last $pkg installation
254 is included below.
255
256 ----------
257 ${CP_NOTICE}----------"
258   
259     echo "$CP_NOTICE" | /usr/sbin/sendmail -t &
260     sleep 1
261   fi
262 }
263
264 # by ddzeko, Mon, 21 Mar 2005 11:31:59 +0100
265 cp_mv () {
266   [ "$CP_SCRIPT_DEBUG" ] && set -vx
267   local new old
268   if [ -z "$2" ]; then
269     return 1
270   fi
271   new="$1"
272   old="$2"
273   if [ -e "$old" ]; then
274     chown --reference "$old" "$new"
275     chmod --reference "$old" "$new"
276   fi
277   mv "$new" "$old"
278 }
279 # by ddzeko, Mon, 21 Mar 2005 13:35:42 +0100
280 cp_yes_no () {
281   [ "$CP_SCRIPT_DEBUG" ] && set -vx
282   local prompt answer
283   prompt="$1"
284   [ "$prompt" ] || prompt="Are you sure?"
285   RET=""
286
287   # check to prevent user from using this when debconf is active
288   # (it would break communication with its backend - uses stdin/out)
289   if [ "$DEBCONF_REDIR" ]; then
290     echo "cp_yes_no: debconf redirection detected" >&2
291     return 1
292   fi
293
294   echo -n "$prompt (y)es/(n)o: "
295   read answer
296   case "$answer" in
297     y*)
298       echo
299       RET=y
300       ;;
301     n*)
302       echo
303       RET=n
304       ;;
305     *)
306       echo
307       echo "Please read the message and choose y or n"
308       cp_yes_no
309       ;;
310   esac
311 }
312
313 # by ddzeko, Tue, 29 Mar 2005 17:37:52 +0200
314 #
315 # db_get seems to return error messages if the requested variable 
316 # is not found - we do not find that desirable, and checking $? with
317 # set -e turned on seems to be a bit of a problem
318 # --> that's why we wrap the db_get call to return unset RET variable
319 #     instead of some gibberish error message that our script does
320 #     not expect
321 cp_db_get() {
322   local var
323   var="$1"
324   
325   # check to prevent user from using this before activating debconf
326   # confmodule needs to be loaded before accessing db_* functions
327   if [ -z "$DEBCONF_REDIR" ]; then
328     echo "cp_db_get: debconf not activated!" >&2
329     return 1
330   fi
331  
332   if ! db_get "$var"; then
333     case "$RET" in
334         *doesn\'t\ exist)
335           RET=""
336           ;;
337         [0-9][0-9]\ ?*) # other errors
338           RET=""
339           ;;
340     esac
341   fi
342 }
343
344 # by ico, Wed, 20 Apr 2005 21:09:54 +0200
345 cp_get_ldap_suffix() {
346   local echo_return
347   echo_return="$CP_ECHO_RETURN" # since we're making our own calls
348   # in our own way we need to set CP_ECHO_RETURN the way we want it
349   # but preserving initial state so it could be used afterwards
350   CP_ECHO_RETURN=""
351
352   [ "$CP_SCRIPT_DEBUG" ] && set -vx
353
354   if [ ! -f /etc/ldap/slapd.conf ]; then
355     echo "cp_get_ldap_suffix: /etc/ldap/slapd.conf: No such file" >&2
356     return 2
357   fi
358   
359   RET="`awk  '/^suffix/      { exit }
360               END            { gsub(/"/, "", $2); print $2 }' \
361              < /etc/ldap/slapd.conf`"
362
363   if [ "`echo $RET | sed 's/,/ /g' | wc -w`" -gt 2 ]; then
364     RET=""
365     echo "cp_get_ldap_suffix: Invalid LDAP suffix in /etc/ldap/slapd.conf" >&2
366     return 2
367   fi
368     
369   [ -z "$RET" ] && echo "cp_get_ldap_suffix: No LDAP suffix in /etc/ldap/slapd.conf" >&2
370   [ -z "$echo_return" ] || echo $RET
371   CP_ECHO_RETURN="$echo_return"
372 }
373
374 # by ico, Wed, 20 Apr 2005 21:09:54 +0200
375 cp_get_ldap_realm() {
376   local echo_return
377   echo_return="$CP_ECHO_RETURN" # since we're making our own calls
378   # in our own way we need to set CP_ECHO_RETURN the way we want it
379   # but preserving initial state so it could be used afterwards
380   CP_ECHO_RETURN=""
381
382   [ "$CP_SCRIPT_DEBUG" ] && set -vx
383
384   if [ ! -f /etc/ldap/slapd.conf ]; then
385     echo "cp_get_ldap_realm: /etc/ldap/slapd.conf: No such file" >&2
386     return 2
387   fi
388  
389   cp_get_ldap_suffix || true
390   RET="`echo $RET | awk -F, '{print $1}' | awk -F= '{print $2}'`"
391
392   [ -z "$RET" ] && echo "cp_get_ldap_realm: No LDAP REALM in /etc/ldap/slapd.conf" >&2
393   [ -z "$echo_return" ] || echo $RET
394   CP_ECHO_RETURN="$echo_return"
395 }