nixpkgs/modules/installer/grub/grub.nix

{ config, pkgs, ... }:

with pkgs.lib;

let

  grubMenuBuilder = pkgs.substituteAll {
    src = ./grub-menu-builder.sh;
    isExecutable = true;
    grub = if config.boot.loader.grub.version == 1
           then pkgs.grub
           else pkgs.grub2;
    inherit (pkgs) bash;
    path = [pkgs.coreutils pkgs.gnused pkgs.gnugrep];
    inherit (config.boot.loader.grub) copyKernels extraEntries extraEntriesBeforeNixOS
      splashImage bootDevice configurationLimit version;
  };
  
in

{

  ###### interface

  options = {
  
    boot.loader.grub = {

      enable = mkOption {
        default = true;
        description = ''
          Whether to enable the GRUB boot loader.
        '';
      };

      version = mkOption {
        default = 1;
        example = 2;
        description = ''
          The version of GRUB to use: <literal>1</literal> for GRUB Legacy
          (versions 0.9x), or <literal>2</literal> for GRUB 2.
        '';
      };

      device = mkOption {
        default = "";
        example = "/dev/hda";
        description = "
          The device on which the boot loader, Grub, will be installed.
          If empty, Grub won't be installed and it's your responsibility
          to make the system bootable.
        ";
      };

      bootDevice = mkOption {
        default = "";
        example = "(hd0,0)";
        description = "
          If the system partition may be wiped on reinstall, it is better
          to have /boot on a small partition. To do it, we need to explain
          to GRUB where the kernels live. Specify the partition here (in 
          GRUB notation).
        ";
      };

      configurationName = mkOption {
        default = "";
        example = "Stable 2.6.21";
        description = "
          Grub entry name instead of default.
        ";
      };

      extraEntries = mkOption {
        default = "";
        example = "
          title Windows
            chainloader (hd0,1)+1
        ";
        description = "
          Any additional entries you want added to the Grub boot menu.
        ";
      };

      extraEntriesBeforeNixOS = mkOption {
        default = false;
        description = "
          Whether extraEntries are included before the default option.
        ";
      };

      splashImage = mkOption {
        default =
          if config.boot.loader.grub.version == 1
          then pkgs.fetchurl {
            url = http://www.gnome-look.org/CONTENT/content-files/36909-soft-tux.xpm.gz;
            sha256 = "14kqdx2lfqvh40h6fjjzqgff1mwk74dmbjvmqphi6azzra7z8d59";
          }
          # GRUB 1.97 doesn't support gzipped XPMs.
          else pkgs.fetchurl {
            url = http://www.gnu.org/graphics/winkler-gnu-blue.png;
            sha256 = "0y8fvxalwxyid4k438k7c21bnv728qjsb92rqfapsmpv2bcj7f6k";
          };
        example = null;
        description = "
          Background image used for Grub.  It must be a 640x480,
          14-colour image in XPM format, optionally compressed with
          <command>gzip</command> or <command>bzip2</command>.  Set to
          <literal>null</literal> to run Grub in text mode.
        ";
      };

      configurationLimit = mkOption {
        default = 100;
        example = 120;
        description = "
          Maximum of configurations in boot menu. GRUB has problems when
          there are too many entries.
        ";
      };

      copyKernels = mkOption {
        default = false;
        description = "
          Whether the Grub menu builder should copy kernels and initial
          ramdisks to /boot.  This is necessary when /nix is on a
          different file system than /boot.
        ";
      };
      
    };

  };
  

  ###### implementation

  config = mkIf config.boot.loader.grub.enable {
  
    system.build.menuBuilder = grubMenuBuilder;

    # Common attribute for boot loaders so only one of them can be
    # set at once.
    system.boot.loader.id = "grub";
    system.boot.loader.kernelFile = "vmlinuz";

    environment.systemPackages =
      mkIf config.boot.loader.grub.enable
           (let version = config.boot.loader.grub.version; in
              assert version != 1 -> version == 2;

              if version == 1
              then [ pkgs.grub ]
              else [ pkgs.grub2 ]);

    # and many other things that have to be moved inside this file.
    
  };
  
}