dh_installinit

   1 #!/usr/bin/perl -w
   2
   3 =head1 NAME
   4
   5 dh_installinit - install init scripts into package build directories
   6
   7 =cut
   8
   9 use strict;
  10 use Debian::Debhelper::Dh_Lib;
  11
  12 =head1 SYNOPSIS
  13
  14 B<dh_installinit> [S<I<debhelper options>>] [B<--name=>I<name>] [B<-n>] [B<-R>] [B<-r>] [B<-d>] [S<B<--> I<params>>]
  15
  16 =head1 DESCRIPTION
  17
  18 dh_installinit is a debhelper program that is responsible for installing
  19 init scripts and associated defaults files into package build directories.
  20
  21 It also automatically generates the postinst and postrm and prerm commands
  22 needed to set up the symlinks in /etc/rc*.d/ and to start and stop the init
  23 scripts.
  24
  25 If a file named debian/package.init exists, then it is installed into
  26 etc/init.d/package in the package build directory, with "package" replaced
  27 by the package name.
  28
  29 If a file named debian/package.default exists, then it is installed into
  30 etc/default/package in the package build directory, with "package" replaced
  31 by the package name.
  32
  33 =head1 OPTIONS
  34
  35 =over 4
  36
  37 =item B<-n>, B<--noscripts>
  38
  39 Do not modify postinst/postrm/prerm scripts.
  40
  41 =item B<-o>, B<--onlyscripts>
  42
  43 Only modify postinst/postrm/prerm scripts, do not actually install any init
  44 script or default files. May be useful if the init script is shipped and/or
  45 installed by upstream in a way that doesn't make it easy to let
  46 dh_installinit find it.
  47
  48 =item B<-R>, B<--restart-after-upgrade>
  49
  50 Do not stop the init script until after the package upgrade has been
  51 completed. This is different than the default behavior, which stops the
  52 script in the prerm, and starts it again in the postinst.
  53
  54 This can be useful for daemons that should not have a possibly long
  55 downtime during upgrade. But you should make sure that the daemon will not
  56 get confused by the package being upgraded while it's running before using
  57 this option.
  58
  59 =item B<-r>, B<--no-restart-on-upgrade>
  60
  61 Do not stop init script on upgrade.
  62
  63 =item B<--no-start>
  64
  65 Do not start the init script on install or upgrade, or stop it on removal.
  66 Only call update-rc.d. Useful for rcS scripts.
  67
  68 =item B<-d>, B<--remove-d>
  69
  70 Remove trailing "d" from the name of the package, and use the result for the
  71 filename the init script is installed as in etc/init.d/ , and the default file
  72 is installed as in etc/default/ . This may be useful for daemons with names
  73 ending in "d". (Note: this takes precedence over the --init-script parameter
  74 described below.)
  75
  76 =item B<-u>I<params> B<--update-rcd-params=>I<params>
  77
  78 =item B<--> I<params>
  79
  80 Pass "params" to L<update-rc.d(8)>. If not specified, "defaults" will be
  81 passed to L<update-rc.d(8)>.
  82
  83 =item B<--name=>I<name>
  84
  85 Install the init script (and default file) using the filename I<name>
  86 instead of the default filename, which is the package name. When this
  87 parameter is used, dh_installinit looks for and installs files named
  88 debian/package.name.init and debian/package.name.default, instead of the
  89 usual debian/package.init and debian/package.default.
  90
  91 =item B<--init-script=>I<scriptname>
  92
  93 Use "scriptname" as the filename the init script is installed as in
  94 etc/init.d/ (and also use it as the filename for the defaults file, if it
  95 is installed). If you use this parameter, dh_installinit will look to see
  96 if a file in the debian/ directory exists that looks like
  97 "package.scriptname" and if so will install it as the init script in
  98 preference to the files it normally installs.
  99
 100 This parameter is deprecated, use the --name parameter instead.
 101
 102 =item B<--error-handler=>I<function>
 103
 104 Call the named shell function if running the init script fails. The
 105 function should be provided in the prerm and postinst scripts, before the
 106 #DEBHELPER# token.
 107
 108 =back
 109
 110 =head1 NOTES
 111
 112 Note that this command is not idempotent. L<dh_prep(1)> should be called
 113 between invocations of this command. Otherwise, it may cause multiple
 114 instances of the same text to be added to maintainer scripts.
 115
 116 =cut
 117
 118 init();
 119
 120 foreach my $package (@{$dh{DOPACKAGES}}) {
 121         my $tmp=tmpdir($package);
 122
 123         # Figure out what filename to install it as.
 124         my $script;
 125         if (defined $dh{NAME}) {
 126                 $script=$dh{NAME};
 127         }
 128         elsif ($dh{D_FLAG}) {
 129                 # -d on the command line sets D_FLAG. We will
 130                 # remove a trailing 'd' from the package name and
 131                 # use that as the name.
 132                 $script=$package;
 133                 if ($script=~m/(.*)d$/) {
 134                         $script=$1;
 135                 }
 136                 else {
 137                         warning("\"$package\" has no final d' in its name, but -d was specified.");
 138                 }
 139         }
 140         elsif ($dh{INIT_SCRIPT}) {
 141                 $script=$dh{INIT_SCRIPT};
 142         }
 143         else {
 144                 $script=$package;
 145         }
 146
 147         my $init=pkgfile($package,$script) || pkgfile($package,"init") ||
 148               pkgfile($package,"init.d");
 149         my $default=pkgfile($package,'default');
 150
 151         if ($default ne '' && ! $dh{ONLYSCRIPTS}) {
 152                 if (! -d "$tmp/etc/default") {
 153                         doit("install","-d","$tmp/etc/default");
 154                 }
 155                 doit("install","-p","-m644",$default,"$tmp/etc/default/$script");
 156         }
 157
 158         if ($init ne '' || $dh{ONLYSCRIPTS}) {
 159                 if (! $dh{ONLYSCRIPTS}) {
 160                         if (! -d "$tmp/etc/init.d") {
 161                                 doit("install","-d","$tmp/etc/init.d");
 162                         }
 163
 164                         doit("install","-p","-m755",$init,"$tmp/etc/init.d/$script");
 165                 }
 166
 167                 # This is set by the -u "foo" command line switch, it's
 168                 # the parameters to pass to update-rc.d. If not set,
 169                 # we have to say "defaults".
 170                 my $params='';
 171                 if (defined($dh{U_PARAMS})) {
 172                         $params=join(' ',@{$dh{U_PARAMS}});
 173                 }
 174                 if ($params eq '') {
 175                         $params="defaults";
 176                 }
 177
 178                 if (! $dh{NOSCRIPTS}) {
 179                         if (! $dh{NO_START}) {
 180                                 if ($dh{RESTART_AFTER_UPGRADE}) {
 181                                         # update-rc.d, and restart (or
 182                                         # start if new install) script
 183                                         autoscript($package,"postinst", "postinst-init-restart",
 184                                                 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
 185                                 }
 186                                 else {
 187                                         # update-rc.d, and start script
 188                                         autoscript($package,"postinst", "postinst-init",
 189                                                 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
 190                                 }
 191
 192                                 if ($dh{R_FLAG} || $dh{RESTART_AFTER_UPGRADE}) {
 193                                         # stops script only on remove
 194                                         autoscript($package,"prerm","prerm-init-norestart",
 195                                                 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
 196                                 }
 197                                 else {
 198                                         # always stops script
 199                                         autoscript($package,"prerm","prerm-init",
 200                                                 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
 201                                 }
 202                         }
 203                         else {
 204                                 # just update-rc.d
 205                                 autoscript($package,"postinst", "postinst-init-nostart",
 206                                         "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
 207                         }
 208
 209                         # removes rc.d links
 210                         autoscript($package,"postrm","postrm-init",
 211                                 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
 212                 }
 213         }
 214 }
 215
 216 =head1 SEE ALSO
 217
 218 L<debhelper(7)>
 219
 220 This program is a part of debhelper.
 221
 222 =head1 AUTHOR
 223
 224 Joey Hess <joeyh@debian.org>
 225
 226 =cut