[daemon] Ship default configuration files

This commit adds plymouthd.defaults and plymouthd.conf.

The former is for distributions to override, and the latter
is for administrators to change.

[set-default-theme] Write plymouthd.conf instead of symlink

Now that the daemon looks for the default theme in configuration
files, we should make plymouth-set-default-theme write the
configuration files instead of doing symlinks.

That's what this commit does.

[main] Try getting default theme from config file

Right now we figure out the default theme via a symlink.
This apprach is very simple, but is also a little cumbersome.

It means as the default theme is changed around we have to move
the symlink around.

The symlink is in /usr.  We really shouldn't be mucking with
/usr when changing defaults.

This commit checks the filesystem for two config files:

/usr/share/plymouth/plymouthd.defaults
and
/etc/plymouth/plymouthd.conf

The first one is for distributions to use.  This is how they can
manage which splash to show from release to release.

The second one is for system administrators.  This is how they
can override distribution policy.

We don't actually ship these files yet.  In the mean time,
(and even after for the forseeable future) the old symlink method
will still work.

[configure] drop --with-default-plugin-link

It's an old interface that I don't think anyone is using.

[configure] change bug report link in AC_INIT

It was my email address, but should probably be bugzilla
(or the mailing list)

[configure] run through autoupdate

This just modernizes the file a bit.

[script] Update default script to use the window X and Y offsets every time

Previously the code was assuming the windows were placed at 0,0. This might not
be the case and the window X and Y values should be used when trying to
position items relative to a window.

This change needs to be applied to all other scripts otherwise mutiple screen
setups may have unaligned elements. Updates scripts should be tested using
multi-head test systems or the x11 test renderer.

[script] Correctly initialise the minimum width when getting minimal window

Values were preset to zero which was the smallest width/height.

[script] Get window value without an index returns area covered by all windows

Calls to Window.GetWidth/Height/X/Y without a window index now return the
values of the area covered by all windows. This is only the case if all the
windows are aligned (either by their centers, or to a corner).

This allows the theme designer to place an object knowing it will be seen on
all screens.

[script] Return NULL when requesting width of nonexistent window

Minor bug, previously would return the index used rather than a NULL. Would
only cause problems when using a width request as a test of the presence of a
window.

[script] Move windows to not start at negative coordinates

When multiple screens are found, the system will now arrange them so they are
all centered, and the top left corner of the largest screen is at 0,0.
No changes to any scripts are needed.

[main] Deactivate terminal on quit if necessary

If we're done with the VT plymouth was running on,
and plymouth wasn't running on the initial VT, we
should jump back to the initial VT and try to
clean up plymouth's VT.

[terminal] Add new ply_terminal_deactivate function

This will jump off the VT associated with the terminal
and deallocate it.

[ply-text-display] don't set mode on every write

Resetting the mode to text on every write means that if you're
using a text plugin and X starts, X's VT keeps getting reset back to
KD_TEXT since those plugins don't stop writing on deactivate (they
have no renderer).

There's no reason to set this mode here anyway; all paths to using
those plugins already do this.

[terminal] keep track of terminal raw/cooked state

Instead of setting the terminal to unbuffered (raw) mode on every
write, keep track of whether it's unbuffered or not at the points
we open and close the terminal.

Deactivate already takes care to set back into buffered mode;
otherwise we can end up resetting the terminal mode under X causing
Enter to send X SIGQUIT.

[main] deactivate renderer before hiding

If we don't deactivate the renderer before hiding the splash, the
drm renderer may scan out the buffer contents to the fbcon buffer;
since we only hide the splash when dumping details or when
--retain-splash is *not* given to quit, this is exactly the
opposite of what we want.

The effect of not doing this is partial splash contents behind the
details in cases of error, or when using quit.  This doesn't affect
plymouth quit --retain-splash.

[daemon] add "has active vt?" request

One problem with the current deactivate/quit transition into X is that
the display manager will, if Plymouth was running, re-use the currently
active VT.

That only works if Plymouth was actually displaying a splash screen on
that VT.  If --show-splash hasn't been called yet because we booted too
fast, we'll be on the wrong VT.

Add a request to ask whether the Plymouth VT is active; I've done it
this way so the answer defaults to "yes" for Fedora who use VT1.

The pseudo-code for transition is thus:

  if plymouth is running (ping):
    plymouth deactivate
    if plymouth has active vt:
      start X on current VT with -nr
      if X starts ok:
        plymouth quit --retain-splash
      else if X fails:
        plymouth quit
    else if plymouth doesn't have active vt:
      plymouth quit
      start X as normal
  else if plymouth isn't running:
    start X as normal

[client] add "has active vt?" request

This asks the daemon whether it has an active VT, used for a smooth
transition into X.

I've implemented this to look like ping.

[two-step] resume animations on display_normal

Change the display_normal() function so that rather than being a no-op
if we already saved the state as normal, it restarts any animations and
redraws the views.

The only thing we now do if the state is not previously the same is
hide any prompt.

This allows this to be used to reanimate the plugin on reactivate.

[throbgress] resume animations on display_normal

Change the display_normal() function so that rather than being a no-op
if we already saved the state as normal, it restarts any animations and
redraws the views.

The only thing we now do if the state is not previously the same is
hide any prompt.

This allows this to be used to reanimate the plugin on reactivate.

[space-flares] resume animations on display_normal

Change the display_normal() function so that rather than being a no-op
if we already saved the state as normal, it restarts any animations and
redraws the views.

The only thing we now do if the state is not previously the same is
hide any prompt.

This allows this to be used to reanimate the plugin on reactivate.

[fade-throbber] resume animations on display_normal

Change the display_normal() function so that rather than being a no-op
if we already saved the state as normal, it restarts any animations and
redraws the views.

The only thing we now do if the state is not previously the same is
hide any prompt.

This allows this to be used to reanimate the plugin on reactivate.

[main] update display after reactivate

Since deactivate uses on_boot_splash_idle, there's a good chance that
plugins will have stopped animating.  Prod them to animate again by
calling update_display()

[client] Add new reactivate command

This tells the daemon to reactivate itself after having previously
been suspended by the deactivate command.

[daemon] Add new reactivate command

More for debugging and completeness than anything else, add a
"reactivate" command to the daemon that undoes the effects of
deactivate and continues the splash screen on its way.

Another possible use for this could be (for example) providing a
seamless shutdown experience.

A future commit will implement the client bits needed.

[main] check for deactivated before no-splash

Since deactivated doesn't mean no boot splash anymore, we have to
check for the "plymouth quit" while deactivated case first.

[main] don't quit splash on deactivate

Currently deactivate is mostly like hide splash, except it deactivates
the renderer first and doesn't reset the VT to text mode and dump the
details plugin over top.

Unfortunately this means that the renderer is closed and freed, and in
the case of the Intel DRM renderer, closing the DRM file descriptor
means that the kernel frees the buffers and restores the fbcon buffer
on our screen - losing the smooth transition.

This now changes deactivate such that it leaves the boot splash open,
but in an inactivate state, with the DRM connection still open, etc.
now the fbcon contents are not restored.

We deliberately stop watching for keyboard input, detach any logging
session from the console, take the VT out of VT_PROCESS mode and
put it back into cooked mode, etc.

This means the X server can be started, and this state can be cleaned
up by calling plymouth quit with affecting X.

[main] call deactivate_splash() even when no splash

To allow deactivate_splash() to do more than affect the boot splash
plugin and renderer, call it from the deactivate path when there is
no boot splash screen as well.

[main] add deactivate_splash() function

To make it easier to alter the deactivate path, split into its own
function.

[terminal] export functions to enable/disable VT watching

In order to deactivate without pulling everything, we need to be able
to take the terminal in and out of VT_PROCESS mode directly; so change
the two functions from static to exported.

[main] Ignore deactivate while deactivated

The other obvious command we should ignore while deactivated is
deactivate itself.

[main] Ignore --hide-splash while deactivated

Since we ignore --show-splash, it makes no sense to process
--hide-splash either; in theory this does nothing already because
we won't have a boot_splash in our state - but that changes with
future patches and it's worth being safe.

[main] Ignore --show-splash while deactivated

The last thing we want to do after plymouth deactivate is called by
the X display manager is listen to calls to show the splash screen
again.

So don't.

[main] Ensure second quit blocks until quit processed

When it comes to quitting, which must be carefully coordinated
with other subsystems during the boot process, we need to make
sure the client doesn't return early.

[main] Ensure second deactivate blocks until deactivation

When it comes to deactivation where the various steps of boot
have to be carefully synchronized, we need to make sure that
the client doesn't return early.

[main] fix bug with multiple quit commands

Likewise if plymouth quit is called when we're waiting for the boot
splash to become idle, we also end up asserting that there's not
already an idle trigger.

Fix it in the same way as deactive, ignore the second quit command
except for pulling its trigger.

[main] fix bug with multiple deactivate commands

If plymouth deactivate is called when we're waiting for the boot
splash to become idle, we end up asserting that there's not
already an idle trigger.

Fix it by checking for an existing deactive trigger, and if there
is, ignoring the new deactivate command (except for pulling its
trigger so it doesn't block).

[main] pull deactivate trigger in quit_program()

To avoid a "plymouth deactivate" command hanging forever in the case
of the program quitting, pull the trigger before the quit trigger.

[main] give quit command precedence over deactivate

In the cases where the boot splash plugin does not become idle
immediately, we go back into the main loop and can receive additional
commands.

Since quit and deactive both use this facility, one scenario is the
quit command arriving after the deactivate command, but before the
deactivate command has actually been run.

In that situation, we want to quit, not deactivate.

[terminal] Add spew for multiple opens and closes

It may help with debugging problems later on.

[branch-merge] Improved VT Handling

One of the main differences between Ubuntu's use of Plymouth and
Fedora's is that on Ubuntu we've tried to keep the X server on VT7
so that the historical documentation of Ctrl-Alt-F1 giving you a
text console is preserved.

This obviously means that for a smooth transition, Plymouth must also
run on VT7.

We discovered that although Plymouth does have code to attempt to deal
with VTs, none of it is quite right and there are many paths that don't
work unless Plymouth is run on VT1.

This patch set fixes our known problems with the VT handling making it
possible to run Plymouth on any VT of your choosing, with VT1 remaining
the default.

[configure] allow boot and shutdown ttys to be changed

Allow distributions like Ubuntu to override the boot and shutdown
ttys from the configure script so they don't have to patch the
source.

[main] add --tty command-line option

Add a command-line option to specify the TTY that plymouth should
use.  This is mostly useful for debugging, for example you can put
plymouth onto a TTY not used by the X server; or if you're feeling
particularly sneaky, plymouth into an xterm.

[terminal] guard open and close against repeated calls

Since we have a status flag whether or not the terminal fd is open,
use it in the open and close functions to guard against repeated
calls.

[x11] default renderer to inactive

Change the renderer so that it defaults to inactive until we
map to the device.

[frame-buffer] default renderer to inactive

Change the renderer so that it defaults to inactive, then when we
map to the device, activate the renderer by activating the VT;
unless the VT is already active in which case activate the
renderer directly.

[drm] default renderer to inactive

Change the renderer so that it defaults to inactive, then when we
map to the device, activate the renderer by activating the VT;
unless the VT is already active in which case activate the
renderer directly.

[terminal,text,details] move activate vt into plugins

Move the responsiblity to activate the VT into the text and details
plugins; this not only matches the graphical renderers, but it also
ensures we activate the VT in all possible code paths.

Previously if we fell back to text.so because we couldn't activate
a renderer, this would not activate the VT.

[x11] ignore terminal completely

The X11 renderer doesn't need a terminal at all, so we ignore it
completely.

[frame-buffer] don't run on non-virtual terminals

We only need support DRM on virtual terminals, those that are not
such as serial consoles, can be trivially skipped.

[drm] don't run on non-virtual terminals

We only need support DRM on virtual terminals, those that are not
such as serial consoles, can be trivially skipped.

[terminal] move terminal opening into renderers/plugins

Move the responsibility to actually open the terminal to the renderers
and text/details plugin, this allows the X11 renderer to not actually
open the terminal - and thus not crash the X server.

[terminal] don't treat ttySx as VT

Only devices with TTY_MAJOR and minor from 0-63 are VTs, 64 onwards
are serial consoles.

[terminal] drop next_active_vt

When we activate our VT, now we actually have it in VT_PROCESS not the
VT we started from, we get the proper signal so don't need an ioctl to
wait until its active.

If we were to leave our VT, we'd get the opposite signal as well and
we don't really care whether we actually get to the other VT, just
that we leave ours.

And this code was in the wrong place anyway.

[terminal] don't keep track of active vt, just if vt is active

Trying to keep track of whatever VT is actually active is inherently
racy; instead just keep track of whether our VT is the active one.
Since we guarantee that's the VT in VT_PROCESS now, this is easy.

Rather simplifies the on_vt_changed functions in renderers too.

[terminal] drop support for opening the foreground terminal

This isn't used anywhere in plymouth, we should always open a named
terminal to avoid surprises due to VT switches we're not watching
for.

[terminal] only support vt-like operations on VTs

Now we can simply test whether a terminal is virtual or not, add
a guard in the mode and vt change functions that ensure they only
operate on virtual terminals.

[terminal] add ply_terminal_is_vt() function

We want to be able to query whether a terminal is an ordinary terminal
or a virtual terminal, rather than looking up the vt number and knowing
what the right numbers are, add a function that knows that.

[terminal] replace set_active_vt with activate_vt

Since a terminal already knows which VT number it is, there's no
need to accept a VT number for switching to this VT.

[console] remove console files

Now that everything's switched over to using ply_terminal_t, we
can remove the console files.

[terminal] remove references to ply_console_t

Remove all of the references to ply_console_t from the code, now
we operate exclusively on the terminal object.  In some places
this means switching from one to the other, but in many it just
means dropping the console object and using the terminal object
we were already passed.

[terminal] merge console and terminal code

This removes the separation in code of "console" functions and
"terminal" functions; this never really made sense, and doesn't
particularly map to the behaviour of Linux virtual terminals.

The three principle operations that Plymouth was using "console"
for were:

 * changing the active VT
 * notification of changes to the active VT through VT_PROCESS
 * switching between text and graphics mode

And it was using the "foreground terminal" alias /dev/tty0 to do
this.  While this is fine for the first of those, since any console
device will do, it's always wrong for the latter two which should
always be on the actual VT we want Plymouth to run from.

If running on tty7, only tty7 should be in VT_PROCESS mode (since
we want to know when we enter this VT and leave this VT), and
certainly only tty7 should be in graphics mode.

Since you can use that same tty to obtain the current active VT,
and switch VT, you don't need another; so the need for a separate
"console" functionality goes away.

[main] unset keyboard if splash fails to show

Since script implements a set_keyboard function (the only plugin to
do so), the previous commit reveals a bug where set_keyboard is
called for the plugin but unset_keyboard isn't called if the plugin
fails to be loaded

[script] check that there are pixel displays

The script plugin only works on pixel displays, however there wasn't
any check for this, so if a script-based theme was your default
Plymouth would not fallback to using the text plugin instead.

[terminal] change fallback terminal settings

I think when I originally added the fallback case, I looked at the
tcgetattr man page, saw cfmakeraw()'s settings and just inverted them.

That's obviously wrong.  These settings should hopefully make a little
more sense.

Spelling fix for manpage.

[script] Add SubString function to the script string library

Adds the SubString function which returns a string segment. The two paramiters
are the sub-string start and end indicies. Negative start and end values return
a NULL, as does start index being beyond the end index. Start being beyond the
end of the string returns an empty string.

[drm] reconnect input source on disconnect

This is like 6f8d51c2cb2f46eac4c2040f5fc8512f65c8d2da
but for the drm renderer.

[frame-buffer] reconnect input source on disconnect

This is like 1425549885aadb21871d1751d71f411cce802d60
but for the frame buffer renderer.

Merge branch 'scriptftbfs'

Merge branch 'scriptdirs'

[main] replace tabs with spaces

Missed these in the clean-up pass.

[script] drop unused on_draw() function

The on_draw() function inside the script plugin isn't referenced
anywhere, but references a static function from script-lib-sprite.c;
if building without optimisation, it's possible that gcc won't elide
this code so will fail during linking.

[scripts] Don't hardcode LIBEXECDIR and DATADIR paths

The scripts hard-coded the paths for LIBEXECDIR and DATADIR, unless
passed as environment variables.  Instead of doing this, which breaks
if plymouth is installed outside of /usr, set these derived from the
configure $libexecdir and $datadir variables just as we do for
pkg-config, etc.

Since we use so many variables, it makes more sense to generate these
scripts from config.status rather than having special Makefile rules
for them.

[main] Write the pid of plymouthd to a file

Add a --pid-file option to plymouthd that will cause the daemon's
pid to be written to the named file.  Useful to avoid grovelling
through ps output to find it again.

[client] Install libply-boot-client library and headers

When communicating with Plymouth from another process, it's
inconvenient to have to keep spawning the plymouth client binary
and keeping track of it - not to mention slow.

It's far cleaner to be able to link to the same boot client code
that the plymouth binary does, and communicate directly.

Place that code in a new libply-boot-client library, and install
the headers along with it.

[keyboard] Handle tty hangup better

We currently reconnect the terminal object on tty disconnects,
but we don't rewatch the keyboard. A disconnect will invalidate
the fd watch, so we need to handle it to prevent crashes.

[server] Add debugging statements

[libply-splash-core] Install to / instead of /usr

Since plymouthd links against this library, we should
probably move it to /lib if plymouthd is installed in
/sbin

[main] Defer password requests to client if daemon unavailable

There are times when plymouthd isn't in a position to ask for
the password (for instance, if the initramfs is about to run
init=/bin/bash or something).  In those cases, any password
requests need to be handled by the client.

[main] Send CTRL-C instead of NULL for password cancel

We'll want to use NULL for "daemon can't ask"

[client] add debugging statements

[client] Run ask-for-password command unconditionally

Even if we can't contact the daemon, we should still run the
ask-for-password command.  This is because the command may
do things important for boot up to continue like unlocking
the root partition.

[client] Don't exit right away if daemon unavailable

We're going to want to be able to carry on in some cases
even if the daemon isn't there.

[client] debug mode if plymouth:debug in /proc/cmdline

We currently do this for the daemon.  We should do it for
the client as well.

[script] Add get functions for all sprite properties

Adds GetImage/X/Y/Z/Opacity to get the current values of the sprites.
This is for convenience of not having to store them in the script.

[script] Use floor when implementing Int

Previously the Math.Int function converted to int and back to double.
The floor function works larger than those represented by integers and it
correctly handles NaN and Inf.

[script] Add a random number generator

Adds Math.Random() which returns a random number between 0 and 1.

[daemon] drop libply-splash-graphics dependency

[branch-merge] Drop libpng requirements from base install

Right now, plymouthd links against libplybootsplash which links
against libpng.  Only graphical splashes use libpng, but it's
always pulled in.

This merge splits libplybootsplash into two libraries: the core
bits, and the extractable graphical bits.  Only the graphical splashes
link against the latter library.  This way server installations can
get plymouth without pulling in libpng.  This will reduce the amount
of security errata deployed to those server installations.

[splash] Split out graphical parts of libply-splash-core

We now have a libply-splash-graphics for handling the
graphical bits.  In particular, this means plymouthd no
longer links against libpng.

[splash] Rename libplybootsplash to libply-splash-core

Splashes aren't just shown for "boot" so including "boot" in
the name isn't right.  Also, right now we link against libpng
even if we don't have any splash that uses it.  This is the first
step toward making libpng only get linked to graphical splashes.

We'll need to move the graphical bits to their own library to
complete the process.

[details] don't include ply-image.h

[main] quit program when quit given after deactivate

If plymouth quit (without --retain-splash) follows plymouth deactivate,
plymouth will never actually quit (or pull the trigger for the client)

[main] avoid crash when no splash running

We haven't saved the passed deactivate trigger to the state,
so it won't be set there.  Just pull it directly.

[main] Don't free renderer when NULL

If we weren't showing the splash screen, we'll have no renderer

[branch-merge] Add man page

This merges the "man-page" branch to master.

Thanks to Adrian Glaubitz we now have a man page for plymouth.

This is a good start to documenting the basics of plymouth.

We'll eventually need more comprehensive reference documentation
before 1.0 is released, and now we have some of the ground work
(a docs/ directory) for that.

[docs] Remove commented out section from man page

We don't have a --version and it was adding a gap in the output

[docs] Update home page url in man page

[docs] Fix AUTHORS in man page