← Back to branch summary

~chalet16/ubuntu/natty/xorg-server/fix-for-518132

« back to all changes in this revision

Viewing changes to debian/xsfbs/xsfbs.sh

  • Committer: Bazaar Package Importer
  • Author(s): Christopher James Halse Rogers, Christopher James Halse Rogers, Timo Aaltonen, Chase Douglas
  • Date: 2011-02-23 09:40:07 UTC
  • mfrom: (1.1.39 upstream) (0.1.22 experimental)
  • Revision ID: james.westby@ubuntu.com-20110223094007-xqwcet0zcbelhj56
Tags: 2:1.9.99.902-2ubuntu1
https://launchpad.net/bugs/371405
https://launchpad.net/bugs/459512
https://launchpad.net/bugs/633593
https://launchpad.net/bugs/711422
https://launchpad.net/bugs/722563
https://launchpad.net/bugs/714696
[ Christopher James Halse Rogers ]
* Merge from Debian experimental.  Remaining Ubuntu changes:
  - rules:
    + Disable SELinux, libaudit-dev is not in main yet. (LP #406226)
    + Enable xcsecurity. (LP #247537)
    + Add --with-extra-module-dir to support GL alternatives.
    + Mention Ubuntu support in builderstring rather than package uploader's
      email address.
  - control:
    + Xvfb depends on xauth, x11-xkb-utils. (LP #500102)
    + Add breaks for incompatible drivers. (LP #614993)
    + Drop libaudit-dev from build-deps.
    + Build-depend on newer mesa to pick up DRI search paths variable.
  - local/xvfb-run*: Add correct docs about error codes. (LP #328205)
  - debian/patches:
    + 100_rethrow_signals.patch:
      When aborting, re-raise signals for apport
    + 105_nvidia_fglrx_autodetect.patch:
      Load proprietary drivers automatically when installed.
    + 109_fix-swcursor-crash.patch:
      Avoid dereferencing null pointer while reloading cursors during
      resume. (LP: #371405)
    + 111_armel-drv-fallbacks.patch:
      Add support for armel driver fallbacks.
    + 121_only_switch_vt_when_active.diff:
      Add a check to prevent the X server from changing the VT when killing
      GDM from the console.
    + 122_xext_fix_card32_overflow_in_xauth.patch:
      Fix server crash when “xauth generate” is called with large timeout.
    + 157_check_null_modes.patch, 162_null_crtc_in_rotation.patch,
      166_nullptr_xinerama_keyrepeat.patch, 167_nullptr_xisbread.patch
      169_mipointer_nullptr_checks.patch,
      172_cwgetbackingpicture_nullptr_check.patch:
      Fix various segfaults in xserver by checking pointers for NULL
      values before dereferencing them.
    + 165_man_xorg_conf_no_device_ident.patch
      Correct man page
    + 168_glibc_trace_to_stderr.patch:
      Report abort traces to stderr instead of terminal
    + 184_virtual_devices_autodetect.patch:
      Use vesa for qemu device, which is not supported by cirrus
    + 188_default_primary_to_first_busid.patch:
      Pick the first device and carry on (LP: #459512)
    + 190_cache-xkbcomp_output_for_fast_start_up.patch:
    + 191-Xorg-add-an-extra-module-path.patch:
      Add support for the alternatives module path.
    + 198_nohwaccess.patch:
      Adds a -nohwaccess argument to make X not access the hardware
      ports directly.
    + 200_randr-null.patch:
      Clarify a pointer initialization.
    + 206_intel_8xx_default_to_fbdev.patch:
      Makes 8xx class intel GPUs default to fbdev for stability. (LP: #633593)
    + 208_switch_on_release.diff:
      Switch keyboard layouts on key-release rather than key-press
        (LP #36812)
    + 209_add_legacy_bgnone_option.patch:
      Add -nr as a synonym for -background none until all ?DM are updated for
        the new option.
    + 210_pixman_null_ptr_check.patch: 
      Catch NULL pointer access after pixman_image_create_bits() failure
        (LP #705078)
    + Add 213_xichangehierarchy-check-oom.patch:
      Add NULL pointer check for out-of-memory conditions. (LP #720445)
    + debian/patches/214_glx_dri_searchdirs.patch:
      Search in same paths as mesa for DRI drivers for AIGLX so we can handle
      UMS fallback for radeon gracefully.
* 211_glx_fix_bindtextimageext_length_check.patch:
* 212_fix_request_length_check_for_createglxpbuffersgix.patch:
  - Drop; these cherry-picks are included in 1.10RC2
* debian/patches/214_glx_dri_searchdirs.patch:
  - Fix nouveau check to downgrade missing DRI error messages to info.
    We don't support nouveau's 3D, so let's not complain too strenuously
    when it's not installed.
* debian/patches/215_glx_drawable_refcounting.diff:
  - Refcount GLXDrawables to avoid use-after-free crashes.  Patch from
    xorg-devel mailing list.  Prevents segfault on logout and server
    regenerate, and possibly other times. (LP: #711422)
* 214_glx_dri_searchdirs.patch:
  - Fix dlclose/free snafu. (LP: #722563)
* debian/inputabiver:
* debian/videoabiver:
* debian/xserver-xorg-dev.install
  - Temporarily re-add these to xserver-xorg-dev so we don't need to merge
    all the driver changes from Debian en masse.  These should be dropped
    once all drivers have been merged from Debian, and certainly in Natty+1.
* debian/serverminver:
  - Include 2ubuntu1 string; Xi 2.1 bumps the minor input ABI, so drivers
    built against it need the Xi 2.1 patched server.

[ Timo Aaltonen ]
* debian/patches/216_dix-valuator-count-of-0-is-valid.diff:
  - For all but motion and proximity events, having no valuators is ok.
    Regression from 1.9, keyboard events are not converted to protocol
    events. (LP: #714696)

[ Chase Douglas ]
* Add in preliminary xi2.1 support
  - Added 500_xi2.1.patch
  - Moved 202_xf86CoordinationsToWindows.patch to
    501_xf86CoordinatesToWindow.patch
  - Moved 203_gestures-extension.patch to 502_gestures-extension.patch
  - Bump dependency on x11proto-input for xi 2.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/xsfbs/xsfbs.sh
1
 
# This is the X Strike Force shell library for X Window System package
2
 
# maintainer scripts.  It serves to define shell functions commonly used by
3
 
# such packages, and performs some error checking necessary for proper operation
4
 
# of those functions.  By itself, it does not "do" much; the maintainer scripts
5
 
# invoke the functions defined here to accomplish package installation and
6
 
# removal tasks.
7
 
 
8
 
# If you are reading this within a Debian package maintainer script (e.g.,
9
 
# /var/lib/dpkg/info/PACKAGE.{config,preinst,postinst,prerm,postrm}), you can
10
 
# skip past this library by scanning forward in this file to the string
11
 
# "GOBSTOPPER".
12
 
 
13
 
SOURCE_VERSION=@SOURCE_VERSION@
14
 
OFFICIAL_BUILD=@OFFICIAL_BUILD@
15
 
 
16
 
# Use special abnormal exit codes so that problems with this library are more
17
 
# easily tracked down.
18
 
SHELL_LIB_INTERNAL_ERROR=86
19
 
SHELL_LIB_THROWN_ERROR=74
20
 
SHELL_LIB_USAGE_ERROR=99
21
 
 
22
 
# old -> new variable names
23
 
if [ -z "$DEBUG_XORG_PACKAGE" ] && [ -n "$DEBUG_XFREE86_PACKAGE" ]; then
24
 
  DEBUG_XORG_PACKAGE="$DEBUG_XFREE86_PACKAGE"
25
 
fi
26
 
if [ -z "$DEBUG_XORG_DEBCONF" ] && [ -n "$DEBUG_XFREE86_DEBCONF" ]; then
27
 
  DEBUG_XORG_DEBCONF="$DEBUG_XFREE86_DEBCONF"
28
 
fi
29
 
 
30
 
# initial sanity checks
31
 
if [ -z "$THIS_PACKAGE" ]; then
32
 
  cat >&2 <<EOF
33
 
Error: package maintainer script attempted to use shell library without
34
 
definining \$THIS_PACKAGE shell variable.  Please report the package name,
35
 
version, and the text of this error message to the Debian Bug Tracking System.
36
 
Visit <http://www.debian.org/Bugs/Reporting> on the World Wide Web for
37
 
instructions, read the file /usr/share/doc/debian/bug-reporting.txt from the
38
 
"doc-debian" package, or install the "reportbug" package and use the command of
39
 
the same name to file a report against version $SOURCE_VERSION of this package.
40
 
EOF
41
 
  exit $SHELL_LIB_USAGE_ERROR
42
 
fi
43
 
 
44
 
if [ -z "$THIS_SCRIPT" ]; then
45
 
  cat >&2 <<EOF
46
 
Error: package maintainer script attempted to use shell library without
47
 
definining \$THIS_SCRIPT shell variable.  Please report the package name,
48
 
version, and the text of this error message to the Debian Bug Tracking System.
49
 
Visit <http://www.debian.org/Bugs/Reporting> on the World Wide Web for
50
 
instructions, read the file /usr/share/doc/debian/bug-reporting.txt from the
51
 
"doc-debian" package, or install the "reportbug" package and use the command of
52
 
the same name to file a report against version $SOURCE_VERSION of the
53
 
"$THIS_PACKAGE" package.
54
 
EOF
55
 
  exit $SHELL_LIB_USAGE_ERROR
56
 
fi
57
 
 
58
 
if [ "$1" = "reconfigure" ] || [ -n "$DEBCONF_RECONFIGURE" ]; then
59
 
  RECONFIGURE="true"
60
 
else
61
 
  RECONFIGURE=
62
 
fi
63
 
 
64
 
if ([ "$1" = "install" ] || [ "$1" = "configure" ]) && [ -z "$2" ]; then
65
 
  FIRSTINST="yes"
66
 
fi
67
 
 
68
 
if [ -z "$RECONFIGURE" ] && [ -z "$FIRSTINST" ]; then
69
 
  UPGRADE="yes"
70
 
fi
71
 
 
72
 
trap "message;\
73
 
      message \"Received signal.  Aborting $THIS_PACKAGE package $THIS_SCRIPT script.\";\
74
 
      message;\
75
 
      exit 1" HUP INT QUIT TERM
76
 
 
77
 
reject_nondigits () {
78
 
  # syntax: reject_nondigits [ operand ... ]
79
 
  #
80
 
  # scan operands (typically shell variables whose values cannot be trusted) for
81
 
  # characters other than decimal digits and barf if any are found
82
 
  while [ -n "$1" ]; do
83
 
    # does the operand contain anything but digits?
84
 
    if ! expr "$1" : "[[:digit:]]\+$" > /dev/null 2>&1; then
85
 
      # can't use die(), because it wraps message() which wraps this function
86
 
      echo "$THIS_PACKAGE $THIS_SCRIPT error: reject_nondigits() encountered" \
87
 
           "possibly malicious garbage \"$1\"" >&2
88
 
      exit $SHELL_LIB_THROWN_ERROR
89
 
    fi
90
 
    shift
91
 
  done
92
 
}
93
 
 
94
 
reject_unlikely_path_chars () {
95
 
  # syntax: reject_unlikely_path_chars [ operand ... ]
96
 
  #
97
 
  # scan operands (typically shell variables whose values cannot be trusted) for
98
 
  # characters unlikely to be seen in a path and which the shell might
99
 
  # interpret and barf if any are found
100
 
  while [ -n "$1" ]; do
101
 
    # does the operand contain any funny characters?
102
 
    if expr "$1" : '.*[!$&()*;<>?|].*' > /dev/null 2>&1; then
103
 
      # can't use die(), because I want to avoid forward references
104
 
      echo "$THIS_PACKAGE $THIS_SCRIPT error: reject_unlikely_path_chars()" \
105
 
           "encountered possibly malicious garbage \"$1\"" >&2
106
 
      exit $SHELL_LIB_THROWN_ERROR
107
 
    fi
108
 
    shift
109
 
  done
110
 
}
111
 
 
112
 
# Query the terminal to establish a default number of columns to use for
113
 
# displaying messages to the user.  This is used only as a fallback in the
114
 
# event the COLUMNS variable is not set.  ($COLUMNS can react to SIGWINCH while
115
 
# the script is running, and this cannot, only being calculated once.)
116
 
DEFCOLUMNS=$(stty size 2> /dev/null | awk '{print $2}') || true
117
 
if ! expr "$DEFCOLUMNS" : "[[:digit:]]\+$" > /dev/null 2>&1; then
118
 
  DEFCOLUMNS=80
119
 
fi
120
 
 
121
 
message () {
122
 
  # pretty-print messages of arbitrary length
123
 
  reject_nondigits "$COLUMNS"
124
 
  echo "$*" | fmt -t -w ${COLUMNS:-$DEFCOLUMNS} >&2
125
 
}
126
 
 
127
 
observe () {
128
 
  # syntax: observe message ...
129
 
  #
130
 
  # issue observational message suitable for logging someday when support for
131
 
  # it exists in dpkg
132
 
  if [ -n "$DEBUG_XORG_PACKAGE" ]; then
133
 
    message "$THIS_PACKAGE $THIS_SCRIPT note: $*"
134
 
  fi
135
 
}
136
 
 
137
 
warn () {
138
 
  # syntax: warn message ...
139
 
  #
140
 
  # issue warning message suitable for logging someday when support for
141
 
  # it exists in dpkg; also send to standard error
142
 
  message "$THIS_PACKAGE $THIS_SCRIPT warning: $*"
143
 
}
144
 
 
145
 
die () {
146
 
  # syntax: die message ...
147
 
  #
148
 
  # exit script with error message
149
 
  message "$THIS_PACKAGE $THIS_SCRIPT error: $*"
150
 
  exit $SHELL_LIB_THROWN_ERROR
151
 
}
152
 
 
153
 
internal_error () {
154
 
  # exit script with error; essentially a "THIS SHOULD NEVER HAPPEN" message
155
 
  message "internal error: $*"
156
 
  if [ -n "$OFFICIAL_BUILD" ]; then
157
 
    message "Please report a bug in the $THIS_SCRIPT script of the" \
158
 
            "$THIS_PACKAGE package, version $SOURCE_VERSION to the Debian Bug" \
159
 
            "Tracking System.  Include all messages above that mention the" \
160
 
            "$THIS_PACKAGE package.  Visit " \
161
 
            "<http://www.debian.org/Bugs/Reporting> on the World Wide Web for" \
162
 
            "instructions, read the file" \
163
 
            "/usr/share/doc/debian/bug-reporting.txt from the doc-debian" \
164
 
            "package, or install the reportbug package and use the command of" \
165
 
            "the same name to file a report."
166
 
  fi
167
 
  exit $SHELL_LIB_INTERNAL_ERROR
168
 
}
169
 
 
170
 
usage_error () {
171
 
  message "usage error: $*"
172
 
  message "Please report a bug in the $THIS_SCRIPT script of the" \
173
 
          "$THIS_PACKAGE package, version $SOURCE_VERSION to the Debian Bug" \
174
 
          "Tracking System.  Include all messages above that mention the" \
175
 
          "$THIS_PACKAGE package.  Visit " \
176
 
          "<http://www.debian.org/Bugs/Reporting> on the World Wide Web for" \
177
 
          "instructions, read the file" \
178
 
          "/usr/share/doc/debian/bug-reporting.txt from the doc-debian" \
179
 
          "package, or install the reportbug package and use the command of" \
180
 
          "the same name to file a report."
181
 
  exit $SHELL_LIB_USAGE_ERROR
182
 
}
183
 
 
184
 
font_update () {
185
 
  # run $UPDATECMDS in $FONTDIRS
186
 
 
187
 
  local dir cmd shortcmd x_font_dir_prefix
188
 
 
189
 
  x_font_dir_prefix="/usr/share/fonts/X11"
190
 
 
191
 
  if [ -z "$UPDATECMDS" ]; then
192
 
    usage_error "font_update() called but \$UPDATECMDS not set"
193
 
  fi
194
 
  if [ -z "$FONTDIRS" ]; then
195
 
    usage_error "font_update() called but \$FONTDIRS not set"
196
 
  fi
197
 
 
198
 
  reject_unlikely_path_chars "$UPDATECMDS"
199
 
  reject_unlikely_path_chars "$FONTDIRS"
200
 
 
201
 
  for dir in $FONTDIRS; do
202
 
    if [ -d "$x_font_dir_prefix/$dir" ]; then
203
 
      for cmd in $UPDATECMDS; do
204
 
        if which "$cmd" > /dev/null 2>&1; then
205
 
          shortcmd=${cmd##*/}
206
 
          observe "running $shortcmd in $dir font directory"
207
 
          cmd_opts=
208
 
          if [ "$shortcmd" = "update-fonts-alias" ]; then
209
 
            cmd_opts=--x11r7-layout
210
 
          fi
211
 
          if [ "$shortcmd" = "update-fonts-dir" ]; then
212
 
            cmd_opts=--x11r7-layout
213
 
          fi
214
 
          if [ "$shortcmd" = "update-fonts-scale" ]; then
215
 
            cmd_opts=--x11r7-layout
216
 
          fi
217
 
          $cmd $cmd_opts $dir || warn "$cmd $cmd_opts $dir" \
218
 
                              "failed; font directory data may not" \
219
 
                              "be up to date"
220
 
        else
221
 
          warn "$cmd not found; not updating corresponding $dir font" \
222
 
               "directory data"
223
 
        fi
224
 
      done
225
 
    else
226
 
      warn "$dir is not a directory; not updating font directory data"
227
 
    fi
228
 
  done
229
 
}
230
 
 
231
 
remove_conffile_prepare () {
232
 
  # syntax: remove_conffile_prepare filename official_md5sum ...
233
 
  #
234
 
  # Check a conffile "filename" against a list of canonical MD5 checksums.
235
 
  # If the file's current MD5 checksum matches one of the "official_md5sum"
236
 
  # operands provided, then prepare the conffile for removal from the system.
237
 
  # We defer actual deletion until the package is configured so that we can
238
 
  # roll this operation back if package installation fails.
239
 
  #
240
 
  # Call this function from a preinst script in the event $1 is "upgrade" or
241
 
  # "install" and verify $2 to ensure the package is being upgraded from a
242
 
  # version (or installed over a version removed-but-not-purged) prior to the
243
 
  # one in which the conffile was obsoleted.
244
 
 
245
 
  local conffile current_checksum
246
 
 
247
 
  # validate arguments
248
 
  if [ $# -lt 2 ]; then
249
 
    usage_error "remove_conffile_prepare() called with wrong number of" \
250
 
                "arguments; expected at least 2, got $#"
251
 
    exit $SHELL_LIB_USAGE_ERROR
252
 
  fi
253
 
 
254
 
  conffile="$1"
255
 
  shift
256
 
 
257
 
  # does the conffile even exist?
258
 
  if [ -e "$conffile" ]; then
259
 
    # calculate its checksum
260
 
    current_checksum=$(md5sum < "$conffile" | sed 's/[[:space:]].*//')
261
 
    # compare it to each supplied checksum
262
 
    while [ -n "$1" ]; do
263
 
      if [ "$current_checksum" = "$1" ]; then
264
 
        # we found a match; move the confffile and stop looking
265
 
        observe "preparing obsolete conffile $conffile for removal"
266
 
        mv "$conffile" "$conffile.$THIS_PACKAGE-tmp"
267
 
        break
268
 
      fi
269
 
      shift
270
 
    done
271
 
  fi
272
 
}
273
 
 
274
 
remove_conffile_lookup () {
275
 
  # syntax: remove_conffile_lookup package filename
276
 
  #
277
 
  # Lookup the md5sum of a conffile in dpkg's database, and prepare for removal
278
 
  # if it matches the actual file's md5sum.
279
 
  #
280
 
  # Call this function when you would call remove_conffile_prepare but only
281
 
  # want to check against dpkg's status database instead of known checksums.
282
 
 
283
 
  local package conffile old_md5sum
284
 
 
285
 
  # validate arguments
286
 
  if [ $# -ne 2 ]; then
287
 
    usage_error "remove_conffile_lookup() called with wrong number of" \
288
 
                "arguments; expected 1, got $#"
289
 
    exit $SHELL_LIB_USAGE_ERROR
290
 
  fi
291
 
 
292
 
  package="$1"
293
 
  conffile="$2"
294
 
 
295
 
  if ! [ -e "$conffile" ]; then
296
 
    return
297
 
  fi
298
 
  old_md5sum="$(dpkg-query -W -f='${Conffiles}' "$package" | \
299
 
    awk '{ if (match($0, "^ '"$conffile"' ")) print $2}')"
300
 
  if [ -n "$old_md5sum" ]; then
301
 
    remove_conffile_prepare "$conffile" "$old_md5sum"
302
 
  fi
303
 
}
304
 
 
305
 
remove_conffile_commit () {
306
 
  # syntax: remove_conffile_commit filename
307
 
  #
308
 
  # Complete the removal of a conffile "filename" that has become obsolete.
309
 
  #
310
 
  # Call this function from a postinst script after having used
311
 
  # remove_conffile_prepare() in the preinst.
312
 
 
313
 
  local conffile
314
 
 
315
 
  # validate arguments
316
 
  if [ $# -ne 1 ]; then
317
 
    usage_error "remove_conffile_commit() called with wrong number of" \
318
 
                "arguments; expected 1, got $#"
319
 
    exit $SHELL_LIB_USAGE_ERROR
320
 
  fi
321
 
 
322
 
  conffile="$1"
323
 
 
324
 
  # if the temporary file created by remove_conffile_prepare() exists, remove it
325
 
  if [ -e "$conffile.$THIS_PACKAGE-tmp" ]; then
326
 
    observe "committing removal of obsolete conffile $conffile"
327
 
    rm "$conffile.$THIS_PACKAGE-tmp"
328
 
  fi
329
 
}
330
 
 
331
 
remove_conffile_rollback () {
332
 
  # syntax: remove_conffile_rollback filename
333
 
  #
334
 
  # Roll back the removal of a conffile "filename".
335
 
  #
336
 
  # Call this function from a postrm script in the event $1 is "abort-upgrade"
337
 
  # or "abort-install" is  after having used remove_conffile_prepare() in the
338
 
  # preinst.
339
 
 
340
 
  local conffile
341
 
 
342
 
  # validate arguments
343
 
  if [ $# -ne 1 ]; then
344
 
    usage_error "remove_conffile_rollback() called with wrong number of" \
345
 
                "arguments; expected 1, got $#"
346
 
    exit $SHELL_LIB_USAGE_ERROR
347
 
  fi
348
 
 
349
 
  conffile="$1"
350
 
 
351
 
  # if the temporary file created by remove_conffile_prepare() exists, move it
352
 
  # back
353
 
  if [ -e "$conffile.$THIS_PACKAGE-tmp" ]; then
354
 
    observe "rolling back removal of obsolete conffile $conffile"
355
 
    mv "$conffile.$THIS_PACKAGE-tmp" "$conffile"
356
 
  fi
357
 
}
358
 
 
359
 
replace_conffile_with_symlink_prepare () {
360
 
  # syntax: replace_conffile_with_symlink_prepare oldfilename newfilename \
361
 
  # official_md5sum ...
362
 
  #
363
 
  # Check a conffile "oldfilename" against a list of canonical MD5 checksums.
364
 
  # If the file's current MD5 checksum matches one of the "official_md5sum"
365
 
  # operands provided, then prepare the conffile for removal from the system.
366
 
  # We defer actual deletion until the package is configured so that we can
367
 
  # roll this operation back if package installation fails. Otherwise copy it
368
 
  # to newfilename and let dpkg handle it through conffiles mechanism.
369
 
  #
370
 
  # Call this function from a preinst script in the event $1 is "upgrade" or
371
 
  # "install" and verify $2 to ensure the package is being upgraded from a
372
 
  # version (or installed over a version removed-but-not-purged) prior to the
373
 
  # one in which the conffile was obsoleted.
374
 
 
375
 
  local conffile current_checksum
376
 
 
377
 
  # validate arguments
378
 
  if [ $# -lt 3 ]; then
379
 
    usage_error "replace_conffile_with_symlink_prepare() called with wrong" \
380
 
                " number of arguments; expected at least 3, got $#"
381
 
    exit $SHELL_LIB_USAGE_ERROR
382
 
  fi
383
 
 
384
 
  oldconffile="$1"
385
 
  shift
386
 
  newconffile="$1"
387
 
  shift
388
 
 
389
 
  remove_conffile_prepare "$_oldconffile" "$@"
390
 
  # If $oldconffile still exists, then md5sums didn't match.
391
 
  # Copy it to new one.
392
 
  if [ -f "$oldconffile" ]; then
393
 
    cp "$oldconffile" "$newconffile"
394
 
  fi
395
 
 
396
 
}
397
 
 
398
 
replace_conffile_with_symlink_commit () {
399
 
  # syntax: replace_conffile_with_symlink_commit oldfilename
400
 
  #
401
 
  # Complete the removal of a conffile "oldfilename" that has been
402
 
  # replaced by a symlink.
403
 
  #
404
 
  # Call this function from a postinst script after having used
405
 
  # replace_conffile_with_symlink_prepare() in the preinst.
406
 
 
407
 
  local conffile
408
 
 
409
 
  # validate arguments
410
 
  if [ $# -ne 1 ]; then
411
 
    usage_error "replace_conffile_with_symlink_commit() called with wrong" \
412
 
                "number of arguments; expected 1, got $#"
413
 
    exit $SHELL_LIB_USAGE_ERROR
414
 
  fi
415
 
 
416
 
  conffile="$1"
417
 
 
418
 
  remove_conffile_commit "$conffile"
419
 
}
420
 
 
421
 
replace_conffile_with_symlink_rollback () {
422
 
  # syntax: replace_conffile_with_symlink_rollback oldfilename newfilename
423
 
  #
424
 
  # Roll back the replacing of a conffile "oldfilename" with symlink to
425
 
  # "newfilename".
426
 
  #
427
 
  # Call this function from a postrm script in the event $1 is "abort-upgrade"
428
 
  # or "abort-install" and verify $2 to ensure the package failed to upgrade
429
 
  # from a version (or install over a version removed-but-not-purged) prior
430
 
  # to the one in which the conffile was obsoleted.
431
 
  # You should have  used replace_conffile_with_symlink_prepare() in the
432
 
  # preinst.
433
 
 
434
 
  local conffile
435
 
 
436
 
  # validate arguments
437
 
  if [ $# -ne 2 ]; then
438
 
    usage_error "replace_conffile_with_symlink_rollback() called with wrong" \
439
 
                "number of arguments; expected 2, got $#"
440
 
    exit $SHELL_LIB_USAGE_ERROR
441
 
  fi
442
 
 
443
 
  oldconffile="$1"
444
 
  newconffile="$2"
445
 
 
446
 
  remove_conffile_rollback "$_oldconffile"
447
 
  if [ -f "$newconffile" ]; then
448
 
    rm "$newconffile"
449
 
  fi
450
 
}
451
 
 
452
 
run () {
453
 
  # syntax: run command [ argument ... ]
454
 
  #
455
 
  # Run specified command with optional arguments and report its exit status.
456
 
  # Useful for commands whose exit status may be nonzero, but still acceptable,
457
 
  # or commands whose failure is not fatal to us.
458
 
  #
459
 
  # NOTE: Do *not* use this function with db_get or db_metaget commands; in
460
 
  # those cases the return value of the debconf command *must* be checked
461
 
  # before the string returned by debconf is used for anything.
462
 
 
463
 
  local retval
464
 
 
465
 
  # validate arguments
466
 
  if [ $# -lt 1 ]; then
467
 
    usage_error "run() called with wrong number of arguments; expected at" \
468
 
                "least 1, got $#"
469
 
    exit $SHELL_LIB_USAGE_ERROR
470
 
  fi
471
 
 
472
 
  "$@" || retval=$?
473
 
 
474
 
  if [ ${retval:-0} -ne 0 ]; then
475
 
    observe "command \"$*\" exited with status $retval"
476
 
  fi
477
 
}
478
 
 
479
 
make_symlink_sane () {
480
 
  # syntax: make_symlink_sane symlink target
481
 
  #
482
 
  # Ensure that the symbolic link symlink exists, and points to target.
483
 
  #
484
 
  # If symlink does not exist, create it and point it at target.
485
 
  #
486
 
  # If symlink exists but is not a symbolic link, back it up.
487
 
  #
488
 
  # If symlink exists, is a symbolic link, but points to the wrong location, fix
489
 
  # it.
490
 
  #
491
 
  # If symlink exists, is a symbolic link, and already points to target, do
492
 
  # nothing.
493
 
  #
494
 
  # This function wouldn't be needed if ln had an -I, --idempotent option.
495
 
 
496
 
  # Validate arguments.
497
 
  if [ $# -ne 2 ]; then
498
 
    usage_error "make_symlink_sane() called with wrong number of arguments;" \
499
 
      "expected 2, got $#"
500
 
    exit $SHELL_LIB_USAGE_ERROR
501
 
  fi
502
 
 
503
 
  # We could just use the positional parameters as-is, but that makes things
504
 
  # harder to follow.
505
 
  local symlink target
506
 
 
507
 
  symlink="$1"
508
 
  target="$2"
509
 
 
510
 
  if [ -L "$symlink" ] && [ "$(readlink "$symlink")" = "$target" ]; then
511
 
      observe "link from $symlink to $target already exists"
512
 
  else
513
 
    observe "creating symbolic link from $symlink to $target"
514
 
    mkdir -p "${target%/*}" "${symlink%/*}"
515
 
    ln -s -b -S ".dpkg-old" "$target" "$symlink"
516
 
  fi
517
 
}
518
 
 
519
 
migrate_dir_to_symlink () {
520
 
  # syntax: migrate_dir_to_symlink old_location new_location
521
 
  #
522
 
  # Per Debian Policy section 6.5.4, "A directory will never be replaced by a
523
 
  # symbolic link to a directory or vice versa; instead, the existing state
524
 
  # (symlink or not) will be left alone and dpkg will follow the symlink if
525
 
  # there is one."
526
 
  #
527
 
  # We have to do it ourselves.
528
 
  #
529
 
  # This function moves the contents of old_location, a directory, into
530
 
  # new_location, a directory, then makes old_location a symbolic link to
531
 
  # new_location.
532
 
  #
533
 
  # old_location need not exist, but if it does, it must be a directory (or a
534
 
  # symlink to a directory).  If it is not, it is backed up.  If new_location
535
 
  # exists already and is not a directory, it is backed up.
536
 
  #
537
 
  # This function should be called from a package's preinst so that other
538
 
  # packages unpacked after this one --- but before this package's postinst runs
539
 
  # --- are unpacked into new_location even if their payloads contain
540
 
  # old_location filespecs.
541
 
 
542
 
  # Validate arguments.
543
 
  if [ $# -ne 2 ]; then
544
 
    usage_error "migrate_dir_to_symlink() called with wrong number of"
545
 
                "arguments; expected 2, got $#"
546
 
    exit $SHELL_LIB_USAGE_ERROR
547
 
  fi
548
 
 
549
 
  # We could just use the positional parameters as-is, but that makes things
550
 
  # harder to follow.
551
 
  local new old
552
 
 
553
 
  old="$1"
554
 
  new="$2"
555
 
 
556
 
  # Is old location a symlink?
557
 
  if [ -L "$old" ]; then
558
 
    # Does it already point to new location?
559
 
    if [ "$(readlink "$old")" = "$new" ]; then
560
 
      # Nothing to do; migration has already been done.
561
 
      observe "migration of $old to $new already done"
562
 
      return 0
563
 
    else
564
 
      # Back it up.
565
 
      warn "backing up symbolic link $old as $old.dpkg-old"
566
 
      mv -b "$old" "$old.dpkg-old"
567
 
    fi
568
 
  fi
569
 
 
570
 
  # Does old location exist, but is not a directory?
571
 
  if [ -e "$old" ] && ! [ -d "$old" ]; then
572
 
      # Back it up.
573
 
      warn "backing up non-directory $old as $old.dpkg-old"
574
 
      mv -b "$old" "$old.dpkg-old"
575
 
  fi
576
 
 
577
 
  observe "migrating $old to $new"
578
 
 
579
 
  # Is new location a symlink?
580
 
  if [ -L "$new" ]; then
581
 
    # Does it point the wrong way, i.e., back to where we're migrating from?
582
 
    if [ "$(readlink "$new")" = "$old" ]; then
583
 
      # Get rid of it.
584
 
      observe "removing symbolic link $new which points to $old"
585
 
      rm "$new"
586
 
    else
587
 
      # Back it up.
588
 
      warn "backing up symbolic link $new as $new.dpkg-old"
589
 
      mv -b "$new" "$new.dpkg-old"
590
 
    fi
591
 
  fi
592
 
 
593
 
  # Does new location exist, but is not a directory?
594
 
  if [ -e "$new" ] && ! [ -d "$new" ]; then
595
 
    warn "backing up non-directory $new as $new.dpkg-old"
596
 
    mv -b "$new" "$new.dpkg-old"
597
 
  fi
598
 
 
599
 
  # Create new directory if it does not yet exist.
600
 
  if ! [ -e "$new" ]; then
601
 
    observe "creating $new"
602
 
    mkdir -p "$new"
603
 
  fi
604
 
 
605
 
  # Copy files in old location to new location.  Back up any filenames that
606
 
  # already exist in the new location with the extension ".dpkg-old".
607
 
  observe "copying files from $old to $new"
608
 
  if ! (cd "$old" && cp -a -b -S ".dpkg-old" . "$new"); then
609
 
    die "error(s) encountered while copying files from $old to $new"
610
 
  fi
611
 
 
612
 
  # Remove files at old location.
613
 
  observe "removing $old"
614
 
  rm -r "$old"
615
 
 
616
 
  # Create symlink from old location to new location.
617
 
  make_symlink_sane "$old" "$new"
618
 
}
619
 
 
620
 
# vim:set ai et sw=2 ts=2 tw=80:
621
 
 
622
 
# GOBSTOPPER: The X Strike Force shell library ends here.