(* virt-sysprep
 * Copyright (C) 2012 Red Hat Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *)

open Printf

open Common_gettext.Gettext
open Sysprep_operation
open Utils

module G = Guestfs

let globs = List.sort compare [
  (* log files *)
  "/var/log/*.log*";
  "/var/log/audit/*";
  "/var/log/btmp*";
  "/var/log/cron*";
  "/var/log/dmesg*";
  "/var/log/lastlog*";
  "/var/log/maillog*";
  "/var/log/mail/*";
  "/var/log/messages*";
  "/var/log/secure*";
  "/var/log/spooler*";
  "/var/log/tallylog*";
  "/var/log/wtmp*";
  "/var/log/apache2/*_log";
  "/var/log/apache2/*_log-*";
  "/var/log/ntp";
  "/var/log/tuned/tuned.log";
  "/var/log/debug*";
  "/var/log/syslog*";
  "/var/log/faillog*";
  "/var/log/firewalld*";
  "/var/log/grubby*";
  "/var/log/xferlog*";

  (* logfiles configured by /etc/logrotate.d/* *)
  "/var/log/BackupPC/LOG";
  "/var/log/ceph/*.log";
  "/var/log/chrony/*.log";
  "/var/log/cups/*_log*";
  "/var/log/glusterfs/*glusterd.vol.log";
  "/var/log/glusterfs/glusterfs.log";
  "/var/log/httpd/*log";
  "/var/log/jetty/jetty-console.log";
  "/var/log/libvirt/libxl/*.log";
  "/var/log/libvirt/libvirtd.log";
  "/var/log/libvirt/lxc/*.log";
  "/var/log/libvirt/qemu/*.log";
  "/var/log/libvirt/uml/*.log";
  "/var/named/data/named.run";
  "/var/log/ppp/connect-errors";
  "/var/log/setroubleshoot/*.log";
  "/var/log/squid/*.log";
  (* And the status file of logrotate *)
  "/var/lib/logrotate.status";

  (* yum installation files *)
  "/root/install.log";
  "/root/install.log.syslog";
  "/root/anaconda-ks.cfg";
  "/root/anaconda-post.log";
  "/root/initial-setup-ks.cfg";
  "/root/original-ks.cfg";
  "/var/log/anaconda.syslog";
  "/var/log/anaconda/*";

  (* debian-installer files *)
  "/var/log/installer/*";

  (* GDM and session preferences. *)
  "/var/cache/gdm/*";
  "/var/lib/AccountService/users/*";

  (* Fingerprint service files *)
  "/var/lib/fprint/*";

  (* fontconfig caches *)
  "/var/cache/fontconfig/*";

  (* man pages cache *)
  "/var/cache/man/*";

  (* log file of sysstat *)
  "/var/log/sa/*";

  (* log file of gdm *)
  "/var/log/gdm/*";

  (* log file of lightdm *)
  "/var/log/lightdm/*";

  (* log file of ntp *)
  "/var/log/ntpstats/*";

  (* Pegasus certificates and other files *)
  "/etc/Pegasus/*.cnf";
  "/etc/Pegasus/*.crt";
  "/etc/Pegasus/*.csr";
  "/etc/Pegasus/*.pem";
  "/etc/Pegasus/*.srl";

  (* Red Hat subscription manager log files *)
  "/var/log/rhsm/*";

  (* journals of systemd *)
  "/var/log/journal/*";

  (* Debian logs: apt & aptitude *)
  "/var/log/aptitude*";
  "/var/log/apt/*";

  (* log files of exim *)
  "/var/log/exim4/*";

  (* log files of ConsoleKit *)
  "/var/log/ConsoleKit/*";
]
let globs_as_pod = pod_of_list globs

let logfiles_perform (g : Guestfs.guestfs) root side_effects =
  let typ = g#inspect_get_type root in
  if typ = "linux" then (
    List.iter (fun glob -> Array.iter g#rm_rf (g#glob_expand glob)) globs
  )

let op = {
  defaults with
    name = "logfiles";
    enabled_by_default = true;
    heading = s_"Remove many log files from the guest";
    pod_description = Some (
      sprintf (f_"\
On Linux the following files are removed:

%s") globs_as_pod);
    perform_on_filesystems = Some logfiles_perform;
}

let () = register_operation op
