nixos-config/nixos/modules/programs/browser.nix

252 lines
7.9 KiB
Nix
Raw Normal View History

2019-10-24 02:20:38 +02:00
{ config, lib, pkgs, ... }:
# todo : this needs to be cleaned up
with lib;
let
cfg = config.programs.custom.browser;
library = import ../../library { inherit pkgs lib; };
2019-10-24 02:20:38 +02:00
chromiumBin = "${pkgs.chromium}/bin/chromium";
chromeBin = "${pkgs.google-chrome}/bin/google-chrome-stable";
firefoxBin = "${pkgs.firefox}/bin/firefox";
tarBin = "${pkgs.gnutar}/bin/tar";
# desktop file
# ------------
# makes it possible to be used by other programs
2019-12-20 05:54:26 +01:00
desktopFile = bin:
let browserName = bin.name;
in pkgs.writeTextFile {
name = "${browserName}.desktop";
destination = "/share/applications/${browserName}.desktop";
text = ''
[Desktop Entry]
Type=Application
Exec=${bin}/bin/${browserName} %U
Icon=chromium
Comment=An open source web browser from Google
Terminal=false
Name=${browserName}
GenericName=Web browser
MimeType=text/html;text/xml;application/xhtml+xml;x-scheme-handler/http;x-scheme-handler/https;x-scheme-handler/ftp;x-scheme-handler/webcal;x-scheme-handler/about
Categories=Network;WebBrowser
StartupWMClass=${browserName}
'';
};
2019-10-24 02:20:38 +02:00
2020-10-12 23:05:15 +02:00
killBrowser = name:
pkgs.writeShellScriptBin "${name}-kill" "sudo killall -9 -u ${name}";
2019-10-24 02:20:38 +02:00
cleanBrowser = name: browser: home: homeBackup:
2019-12-20 05:54:26 +01:00
let
backupFile = "${homeBackup}.tar.lzma";
rolloutFile = "${home}.tar.lzma";
lockFile = "${home}-lock";
in pkgs.writeShellScriptBin "${name}-clean" # sh
''
sudo killall -9 -u ${name}
2020-10-12 23:05:15 +02:00
sudo rm -f ${lockFile}
2019-12-20 05:54:26 +01:00
sudo rm -rf ${home}
'';
2019-10-24 02:20:38 +02:00
createBrowser = name: user: browser: home: homeBackup:
2019-12-20 05:54:26 +01:00
let
backupFile = "${homeBackup}.tar.lzma";
rolloutFile = "${home}.tar.lzma";
lockFile = "${home}-lock";
in pkgs.writeShellScriptBin "${name}" # sh
''
# set -x
if [[ ! -e ${lockFile} ]]
2019-10-24 02:20:38 +02:00
then
2019-12-20 05:54:26 +01:00
# rollout backup
if [[ -e ${backupFile} ]]
2019-10-24 02:20:38 +02:00
then
2019-12-20 05:54:26 +01:00
if [[ ! -d ${home} ]]
then
# todo : use make user
sudo mkdir -p ${home}
sudo chown -R ${user}:users ${home}
fi
cp ${backupFile} ${rolloutFile}
sudo -u ${user} ${tarBin} xf ${rolloutFile} --directory ${home}
rm ${rolloutFile}
touch ${lockFile}
2019-10-24 02:20:38 +02:00
fi
fi
2019-12-20 05:54:26 +01:00
sudo -u ${user} ${browser}
'';
2019-10-24 02:20:38 +02:00
2019-12-20 05:54:26 +01:00
browserExecutableList = let
allBrowser = flip mapAttrsToList cfg.configList (name: config:
2019-10-24 02:20:38 +02:00
let
2019-12-20 05:54:26 +01:00
browser = if config.browserType == "chrome" then
''${chromiumBin} "$@"''
else if config.browserType == "google" then
''${chromeBin} "$@"''
else
''${firefoxBin} "$@"'';
in createBrowser name config.user browser config.home config.homeBackup);
2019-10-24 02:20:38 +02:00
xclipBrowser = [
2019-12-20 05:54:26 +01:00
(pkgs.writeShellScriptBin "copy-to-xclip" # sh
''
echo "$*" | ${pkgs.xclip}/bin/xclip
'')
2019-10-24 02:20:38 +02:00
];
2019-12-20 05:54:26 +01:00
in allBrowser ++ xclipBrowser;
2019-10-24 02:20:38 +02:00
createBackupScript = name: home: backupHome:
2019-12-20 05:54:26 +01:00
pkgs.writeShellScriptBin "${name}-backup" # sh
''
sudo -u ${name} \
${tarBin} \
--exclude=.cache \
--exclude=Downloads \
--create \
--verbos \
--lzma \
--file ${home}.tar.lzma \
--directory ${home} \
.
cp ${home}.tar.lzma ${backupHome}.tar.lzma
'';
2019-10-24 02:20:38 +02:00
2019-12-20 05:54:26 +01:00
allBackupScripts = let
filteredConfigs =
filterAttrs (name: browserConfig: browserConfig.homeBackup != null)
cfg.configList;
in mapAttrsToList (name: browserConfig:
createBackupScript name browserConfig.home browserConfig.homeBackup)
filteredConfigs;
allCleanScripts = let
filteredConfigs =
filterAttrs (name: browserConfig: browserConfig.homeBackup != null)
cfg.configList;
in mapAttrsToList (name: browserConfig:
cleanBrowser name name browserConfig.home browserConfig.homeBackup)
filteredConfigs;
2019-10-24 02:20:38 +02:00
2020-10-12 23:05:15 +02:00
allKillScripts = mapAttrsToList (name: _: killBrowser name) cfg.configList;
2019-10-24 02:20:38 +02:00
# browser chooser
# ---------------
2019-12-20 05:54:26 +01:00
browserSelect = pkgs.writeScriptBin "browser-select" ''
2019-10-24 02:20:38 +02:00
# select a browser using dmenu
# ----------------------------
2019-12-20 05:54:26 +01:00
BROWSER=$( echo -e "${
lib.concatMapStringsSep "\\n" (bin: bin.name) browserExecutableList
}" \
2019-10-24 02:20:38 +02:00
| ${pkgs.rofi}/bin/rofi -dmenu )
# start selected browser
# ----------------------
case $BROWSER in
2019-12-20 05:54:26 +01:00
${lib.concatStringsSep "\n" (flip map browserExecutableList
(bin: "${bin.name}) export BIN=${bin}/bin/${bin.name} ;;"))}
2019-10-24 02:20:38 +02:00
esac
$BIN "$@"
'';
in {
options.programs.custom.browser = {
enable = mkEnableOption "enable browsers";
configList = mkOption {
2019-12-20 05:54:26 +01:00
type = with types;
attrsOf (submodule ({ name, ... }: {
options = {
browserType = mkOption {
type = with types; enum [ "firefox" "chrome" "google" ];
default = "chrome";
description = ''
the type of browser which is simulated
'';
};
home = mkOption {
type = with types; str;
description = ''
Home of the browser.
'';
};
2021-05-15 11:27:05 +02:00
gpu = mkOption {
type = with types; bool;
default = true;
description = ''
add browser user to video group so give browser rights to use gpu.
see : chrome://gpu/
'';
};
2019-12-20 05:54:26 +01:00
user = mkOption {
default = name;
type = with types; str;
description = ''
user to run the browser as
'';
};
sudoUsers = mkOption {
default = [ config.users.users.mainUser.name ];
type = with types; listOf str;
description = ''
user allowed to run sudo without password to start the browser
'';
};
homeBackup = mkOption {
type = with types; nullOr str;
default = null;
example = "~/.my-browser-backup";
description = ''
backup of the home, which gets rolled out if the
home does not exists. usefull for homes in tmpfs.
dont use file endings!
'';
};
2019-10-24 02:20:38 +02:00
};
2019-12-20 05:54:26 +01:00
}));
2019-10-24 02:20:38 +02:00
};
};
config = mkIf cfg.enable {
# add sudo rights
2019-12-20 05:54:26 +01:00
security.sudo.extraConfig = let
extraRules = flip mapAttrsToList cfg.configList (name: values:
2020-10-12 22:46:55 +02:00
concatStringsSep "" (map (sudoUser: ''
# sudo configuration to control browser
${sudoUser} ALL=(${values.user}) NOPASSWD: ALL
${sudoUser} ALL=(root) NOPASSWD: /run/current-system/sw/bin/mkdir -p ${values.home}
${sudoUser} ALL=(root) NOPASSWD: /run/current-system/sw/bin/chown -R ${values.user}\:users ${values.home}
${sudoUser} ALL=(root) NOPASSWD: /run/current-system/sw/bin/killall -9 -u ${name}
${sudoUser} ALL=(root) NOPASSWD: /run/current-system/sw/bin/rm -rf ${values.home}
2020-10-12 23:05:15 +02:00
${sudoUser} ALL=(root) NOPASSWD: /run/current-system/sw/bin/rm -f ${values.home}-lock
2020-10-12 22:46:55 +02:00
'') values.sudoUsers));
2019-12-20 05:54:26 +01:00
in lib.concatStringsSep "\n" extraRules;
2019-10-24 02:20:38 +02:00
# create users
2019-12-20 05:54:26 +01:00
users.users = flip mapAttrs cfg.configList (name: config: {
home = config.home;
createHome = true;
initialPassword = "${name}-browser";
shell = pkgs.bashInteractive;
isNormalUser = true;
group = "users";
# enable video usage
2021-05-15 11:27:05 +02:00
extraGroups = if config.gpu then [ "video" "audio" ] else [ "audio" ];
2019-12-20 05:54:26 +01:00
});
2019-10-24 02:20:38 +02:00
# add groups to mainUser
system.custom.mainUser.extraGroups = builtins.attrNames cfg.configList;
2019-12-20 05:54:26 +01:00
environment.systemPackages = [ browserSelect (desktopFile browserSelect) ]
++ browserExecutableList
++ (map (bin: desktopFile bin) browserExecutableList) ++ allBackupScripts
2020-10-12 23:05:15 +02:00
++ allCleanScripts ++ allKillScripts;
2019-10-24 02:20:38 +02:00
};
}