[linux-block.git] / scripts / sphinx-pre-install

#!/usr/bin/perl
# SPDX-License-Identifier: GPL-2.0-or-later
use strict;

# Copyright (c) 2017-2019 Mauro Carvalho Chehab <mchehab@kernel.org>
#

my $prefix = "./";
$prefix = "$ENV{'srctree'}/" if ($ENV{'srctree'});

my $conf = $prefix . "Documentation/conf.py";
my $requirement_file = $prefix . "Documentation/sphinx/requirements.txt";
my $virtenv_prefix = "sphinx_";

#
# Static vars
#

my %missing;
my $system_release;
my $need = 0;
my $optional = 0;
my $need_symlink = 0;
my $need_sphinx = 0;
my $rec_sphinx_upgrade = 0;
my $install = "";
my $virtenv_dir = "";
my $min_version;

#
# Command line arguments
#

my $pdf = 1;
my $virtualenv = 1;
my $version_check = 0;

#
# List of required texlive packages on Fedora and OpenSuse
#

my %texlive = (
	'amsfonts.sty'       => 'texlive-amsfonts',
	'amsmath.sty'        => 'texlive-amsmath',
	'amssymb.sty'        => 'texlive-amsfonts',
	'amsthm.sty'         => 'texlive-amscls',
	'anyfontsize.sty'    => 'texlive-anyfontsize',
	'atbegshi.sty'       => 'texlive-oberdiek',
	'bm.sty'             => 'texlive-tools',
	'capt-of.sty'        => 'texlive-capt-of',
	'cmap.sty'           => 'texlive-cmap',
	'ecrm1000.tfm'       => 'texlive-ec',
	'eqparbox.sty'       => 'texlive-eqparbox',
	'eu1enc.def'         => 'texlive-euenc',
	'fancybox.sty'       => 'texlive-fancybox',
	'fancyvrb.sty'       => 'texlive-fancyvrb',
	'float.sty'          => 'texlive-float',
	'fncychap.sty'       => 'texlive-fncychap',
	'footnote.sty'       => 'texlive-mdwtools',
	'framed.sty'         => 'texlive-framed',
	'luatex85.sty'       => 'texlive-luatex85',
	'multirow.sty'       => 'texlive-multirow',
	'needspace.sty'      => 'texlive-needspace',
	'palatino.sty'       => 'texlive-psnfss',
	'parskip.sty'        => 'texlive-parskip',
	'polyglossia.sty'    => 'texlive-polyglossia',
	'tabulary.sty'       => 'texlive-tabulary',
	'threeparttable.sty' => 'texlive-threeparttable',
	'titlesec.sty'       => 'texlive-titlesec',
	'ucs.sty'            => 'texlive-ucs',
	'upquote.sty'        => 'texlive-upquote',
	'wrapfig.sty'        => 'texlive-wrapfig',
);

#
# Subroutines that checks if a feature exists
#

sub check_missing(%)
{
	my %map = %{$_[0]};

	foreach my $prog (sort keys %missing) {
		my $is_optional = $missing{$prog};

		# At least on some LTS distros like CentOS 7, texlive doesn't
		# provide all packages we need. When such distros are
		# detected, we have to disable PDF output.
		#
		# So, we need to ignore the packages that distros would
		# need for LaTeX to work
		if ($is_optional == 2 && !$pdf) {
			$optional--;
			next;
		}

		if ($is_optional) {
			print "Warning: better to also install \"$prog\".\n";
		} else {
			print "ERROR: please install \"$prog\", otherwise, build won't work.\n";
		}
		if (defined($map{$prog})) {
			$install .= " " . $map{$prog};
		} else {
			$install .= " " . $prog;
		}
	}

	$install =~ s/^\s//;
}

sub add_package($$)
{
	my $package = shift;
	my $is_optional = shift;

	$missing{$package} = $is_optional;
	if ($is_optional) {
		$optional++;
	} else {
		$need++;
	}
}

sub check_missing_file($$$)
{
	my $file = shift;
	my $package = shift;
	my $is_optional = shift;

	return if(-e $file);

	add_package($package, $is_optional);
}

sub findprog($)
{
	foreach(split(/:/, $ENV{PATH})) {
		return "$_/$_[0]" if(-x "$_/$_[0]");
	}
}

sub check_program($$)
{
	my $prog = shift;
	my $is_optional = shift;

	return if findprog($prog);

	add_package($prog, $is_optional);
}

sub check_perl_module($$)
{
	my $prog = shift;
	my $is_optional = shift;

	my $err = system("perl -M$prog -e 1 2>/dev/null /dev/null");
	return if ($err == 0);

	add_package($prog, $is_optional);
}

sub check_python_module($$)
{
	my $prog = shift;
	my $is_optional = shift;

	my $err = system("python3 -c 'import $prog' 2>/dev/null /dev/null");
	return if ($err == 0);
	my $err = system("python -c 'import $prog' 2>/dev/null /dev/null");
	return if ($err == 0);

	add_package($prog, $is_optional);
}

sub check_rpm_missing($$)
{
	my @pkgs = @{$_[0]};
	my $is_optional = $_[1];

	foreach my $prog(@pkgs) {
		my $err = system("rpm -q '$prog' 2>/dev/null >/dev/null");
		add_package($prog, $is_optional) if ($err);
	}
}

sub check_pacman_missing($$)
{
	my @pkgs = @{$_[0]};
	my $is_optional = $_[1];

	foreach my $prog(@pkgs) {
		my $err = system("pacman -Q '$prog' 2>/dev/null >/dev/null");
		add_package($prog, $is_optional) if ($err);
	}
}

sub check_missing_tex($)
{
	my $is_optional = shift;
	my $kpsewhich = findprog("kpsewhich");

	foreach my $prog(keys %texlive) {
		my $package = $texlive{$prog};
		if (!$kpsewhich) {
			add_package($package, $is_optional);
			next;
		}
		my $file = qx($kpsewhich $prog);
		add_package($package, $is_optional) if ($file =~ /^\s*$/);
	}
}

sub get_sphinx_fname()
{
	my $fname = "sphinx-build";
	return $fname if findprog($fname);

	$fname = "sphinx-build-3";
	if (findprog($fname)) {
		$need_symlink = 1;
		return $fname;
	}

	if ($virtualenv) {
		my $prog = findprog("virtualenv-3");
		$prog = findprog("virtualenv-3.5") if (!$prog);

		check_program("virtualenv", 0) if (!$prog);
		$need_sphinx = 1;
	} else {
		add_package("python-sphinx", 0);
	}

	return "";
}

sub check_sphinx()
{
	my $rec_version;
	my $cur_version;

	open IN, $conf or die "Can't open $conf";
	while (<IN>) {
		if (m/^\s*needs_sphinx\s*=\s*[\'\"]([\d\.]+)[\'\"]/) {
			$min_version=$1;
			last;
		}
	}
	close IN;

	die "Can't get needs_sphinx version from $conf" if (!$min_version);

	open IN, $requirement_file or die "Can't open $requirement_file";
	while (<IN>) {
		if (m/^\s*Sphinx\s*==\s*([\d\.]+)$/) {
			$rec_version=$1;
			last;
		}
	}
	close IN;

	die "Can't get recommended sphinx version from $requirement_file" if (!$min_version);

	$virtenv_dir = $virtenv_prefix . $rec_version;

	my $sphinx = get_sphinx_fname();
	return if ($sphinx eq "");

	open IN, "$sphinx --version 2>&1 |" or die "$sphinx returned an error";
	while (<IN>) {
		if (m/^\s*sphinx-build\s+([\d\.]+)$/) {
			$cur_version=$1;
			last;
		}
		# Sphinx 1.2.x uses a different format
		if (m/^\s*Sphinx.*\s+([\d\.]+)$/) {
			$cur_version=$1;
			last;
		}
	}
	close IN;

	die "$sphinx didn't return its version" if (!$cur_version);

	if ($cur_version lt $min_version) {
		printf "ERROR: Sphinx version is %s. It should be >= %s (recommended >= %s)\n",
		       $cur_version, $min_version, $rec_version;;
		$need_sphinx = 1;
		return;
	}

	if ($cur_version lt $rec_version) {
		printf "Sphinx version %s\n", $cur_version;
		print "Warning: It is recommended at least Sphinx version $rec_version.\n";
		$rec_sphinx_upgrade = 1;
		return;
	}

	# On version check mode, just assume Sphinx has all mandatory deps
	exit (0) if ($version_check);
}

#
# Ancillary subroutines
#

sub catcheck($)
{
  my $res = "";
  $res = qx(cat $_[0]) if (-r $_[0]);
  return $res;
}

sub which($)
{
	my $file = shift;
	my @path = split ":", $ENV{PATH};

	foreach my $dir(@path) {
		my $name = $dir.'/'.$file;
		return $name if (-x $name );
	}
	return undef;
}

#
# Subroutines that check distro-specific hints
#

sub give_debian_hints()
{
	my %map = (
		"python-sphinx"		=> "python3-sphinx",
		"sphinx_rtd_theme"	=> "python3-sphinx-rtd-theme",
		"virtualenv"		=> "virtualenv",
		"dot"			=> "graphviz",
		"convert"		=> "imagemagick",
		"Pod::Usage"		=> "perl-modules",
		"xelatex"		=> "texlive-xetex",
		"rsvg-convert"		=> "librsvg2-bin",
	);

	if ($pdf) {
		check_missing_file("/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf",
				   "fonts-dejavu", 2);
	}

	check_program("dvipng", 2) if ($pdf);
	check_missing(\%map);

	return if (!$need && !$optional);
	printf("You should run:\n\n\tsudo apt-get install $install\n");
}

sub give_redhat_hints()
{
	my %map = (
		"python-sphinx"		=> "python3-sphinx",
		"sphinx_rtd_theme"	=> "python3-sphinx_rtd_theme",
		"virtualenv"		=> "python3-virtualenv",
		"dot"			=> "graphviz",
		"convert"		=> "ImageMagick",
		"Pod::Usage"		=> "perl-Pod-Usage",
		"xelatex"		=> "texlive-xetex-bin",
		"rsvg-convert"		=> "librsvg2-tools",
	);

	my @fedora26_opt_pkgs = (
		"graphviz-gd",		# Fedora 26: needed for PDF support
	);

	my @fedora_tex_pkgs = (
		"texlive-collection-fontsrecommended",
		"texlive-collection-latex",
		"dejavu-sans-fonts",
		"dejavu-serif-fonts",
		"dejavu-sans-mono-fonts",
	);

	#
	# Checks valid for RHEL/CentOS version 7.x.
	#
	my $old = 0;
	my $rel;
	$rel = $1 if ($system_release =~ /release\s+(\d+)/);

	if (!($system_release =~ /Fedora/)) {
		$map{"virtualenv"} = "python-virtualenv";

		if ($rel && $rel < 8) {
			$old = 1;
			$pdf = 0;

			printf("Note: texlive packages on RHEL/CENTOS <= 7 are incomplete. Can't support PDF output\n");
			printf("If you want to build PDF, please read:\n");
			printf("\thttps://www.systutorials.com/241660/how-to-install-tex-live-on-centos-7-linux/\n");
		}
	} else {
		if ($rel && $rel < 26) {
			$old = 1;
		}
	}
	if (!$rel) {
		printf("Couldn't identify release number\n");
		$old = 1;
		$pdf = 0;
	}

	check_rpm_missing(\@fedora26_opt_pkgs, 2) if ($pdf && !$old);
	check_rpm_missing(\@fedora_tex_pkgs, 2) if ($pdf);
	check_missing_tex(2) if ($pdf);
	check_missing(\%map);

	return if (!$need && !$optional);

	if (!$old) {
		# dnf, for Fedora 18+
		printf("You should run:\n\n\tsudo dnf install -y $install\n");
	} else {
		# yum, for RHEL (and clones) or Fedora version < 18
		printf("You should run:\n\n\tsudo yum install -y $install\n");
	}
}

sub give_opensuse_hints()
{
	my %map = (
		"python-sphinx"		=> "python3-sphinx",
		"sphinx_rtd_theme"	=> "python3-sphinx_rtd_theme",
		"virtualenv"		=> "python3-virtualenv",
		"dot"			=> "graphviz",
		"convert"		=> "ImageMagick",
		"Pod::Usage"		=> "perl-Pod-Usage",
		"xelatex"		=> "texlive-xetex-bin",
		"rsvg-convert"		=> "rsvg-view",
	);

	my @suse_tex_pkgs = (
		"texlive-babel-english",
		"texlive-caption",
		"texlive-colortbl",
		"texlive-courier",
		"texlive-dvips",
		"texlive-helvetic",
		"texlive-makeindex",
		"texlive-metafont",
		"texlive-metapost",
		"texlive-palatino",
		"texlive-preview",
		"texlive-times",
		"texlive-zapfchan",
		"texlive-zapfding",
	);

	$map{"latexmk"} = "texlive-latexmk-bin";

	check_rpm_missing(\@suse_tex_pkgs, 2) if ($pdf);
	check_missing_tex(2) if ($pdf);
	check_missing(\%map);

	return if (!$need && !$optional);
	printf("You should run:\n\n\tsudo zypper install --no-recommends $install\n");
}

sub give_mageia_hints()
{
	my %map = (
		"python-sphinx"		=> "python3-sphinx",
		"sphinx_rtd_theme"	=> "python3-sphinx_rtd_theme",
		"virtualenv"		=> "python3-virtualenv",
		"dot"			=> "graphviz",
		"convert"		=> "ImageMagick",
		"Pod::Usage"		=> "perl-Pod-Usage",
		"xelatex"		=> "texlive",
		"rsvg-convert"		=> "librsvg2-tools",
	);

	my @tex_pkgs = (
		"texlive-fontsextra",
	);

	$map{"latexmk"} = "texlive-collection-basic";

	check_rpm_missing(\@tex_pkgs, 2) if ($pdf);
	check_missing(\%map);

	return if (!$need && !$optional);
	printf("You should run:\n\n\tsudo urpmi $install\n");
}

sub give_arch_linux_hints()
{
	my %map = (
		"sphinx_rtd_theme"	=> "python-sphinx_rtd_theme",
		"virtualenv"		=> "python-virtualenv",
		"dot"			=> "graphviz",
		"convert"		=> "imagemagick",
		"xelatex"		=> "texlive-bin",
		"rsvg-convert"		=> "extra/librsvg",
	);

	my @archlinux_tex_pkgs = (
		"texlive-core",
		"texlive-latexextra",
		"ttf-dejavu",
	);
	check_pacman_missing(\@archlinux_tex_pkgs, 2) if ($pdf);

	check_missing(\%map);

	return if (!$need && !$optional);
	printf("You should run:\n\n\tsudo pacman -S $install\n");
}

sub give_gentoo_hints()
{
	my %map = (
		"sphinx_rtd_theme"	=> "dev-python/sphinx_rtd_theme",
		"virtualenv"		=> "dev-python/virtualenv",
		"dot"			=> "media-gfx/graphviz",
		"convert"		=> "media-gfx/imagemagick",
		"xelatex"		=> "dev-texlive/texlive-xetex media-fonts/dejavu",
		"rsvg-convert"		=> "gnome-base/librsvg",
	);

	check_missing_file("/usr/share/fonts/dejavu/DejaVuSans.ttf",
			   "media-fonts/dejavu", 2) if ($pdf);

	check_missing(\%map);

	return if (!$need && !$optional);

	printf("You should run:\n\n");
	printf("\tsudo su -c 'echo \"media-gfx/imagemagick svg png\" > /etc/portage/package.use/imagemagick'\n");
	printf("\tsudo su -c 'echo \"media-gfx/graphviz cairo pdf\" > /etc/portage/package.use/graphviz'\n");
	printf("\tsudo emerge --ask $install\n");

}

sub check_distros()
{
	# Distro-specific hints
	if ($system_release =~ /Red Hat Enterprise Linux/) {
		give_redhat_hints;
		return;
	}
	if ($system_release =~ /CentOS/) {
		give_redhat_hints;
		return;
	}
	if ($system_release =~ /Scientific Linux/) {
		give_redhat_hints;
		return;
	}
	if ($system_release =~ /Oracle Linux Server/) {
		give_redhat_hints;
		return;
	}
	if ($system_release =~ /Fedora/) {
		give_redhat_hints;
		return;
	}
	if ($system_release =~ /Ubuntu/) {
		give_debian_hints;
		return;
	}
	if ($system_release =~ /Debian/) {
		give_debian_hints;
		return;
	}
	if ($system_release =~ /openSUSE/) {
		give_opensuse_hints;
		return;
	}
	if ($system_release =~ /Mageia/) {
		give_mageia_hints;
		return;
	}
	if ($system_release =~ /Arch Linux/) {
		give_arch_linux_hints;
		return;
	}
	if ($system_release =~ /Gentoo/) {
		give_gentoo_hints;
		return;
	}

	#
	# Fall-back to generic hint code for other distros
	# That's far from ideal, specially for LaTeX dependencies.
	#
	my %map = (
		"sphinx-build" => "sphinx"
	);
	check_missing_tex(2) if ($pdf);
	check_missing(\%map);
	print "I don't know distro $system_release.\n";
	print "So, I can't provide you a hint with the install procedure.\n";
	print "There are likely missing dependencies.\n";
}

#
# Common dependencies
#

sub check_needs()
{
	# Check for needed programs/tools
	check_sphinx();

	if ($system_release) {
		print "Detected OS: $system_release.\n\n";
	} else {
		print "Unknown OS\n\n";
	}

	print "To upgrade Sphinx, use:\n\n" if ($rec_sphinx_upgrade);

	# Check for needed programs/tools
	check_perl_module("Pod::Usage", 0);
	check_program("make", 0);
	check_program("gcc", 0);
	check_python_module("sphinx_rtd_theme", 1) if (!$virtualenv);
	check_program("dot", 1);
	check_program("convert", 1);

	# Extra PDF files - should use 2 for is_optional
	check_program("xelatex", 2) if ($pdf);
	check_program("rsvg-convert", 2) if ($pdf);
	check_program("latexmk", 2) if ($pdf);

	check_distros();

	if ($need_symlink) {
		printf "\tsudo ln -sf %s /usr/bin/sphinx-build\n\n",
		       which("sphinx-build-3");
	}
	if ($need_sphinx || $rec_sphinx_upgrade) {
		my $min_activate = "$ENV{'PWD'}/${virtenv_prefix}${min_version}/bin/activate";
		my @activates = glob "$ENV{'PWD'}/${virtenv_prefix}*/bin/activate";

		@activates = sort {$b cmp $a} @activates;

		if ($need_sphinx && scalar @activates > 0 && $activates[0] ge $min_activate) {
			printf "\nNeed to activate a compatible Sphinx version on virtualenv with:\n";
			printf "\t. $activates[0]\n";
			exit (1);
		} else {
			my $rec_activate = "$virtenv_dir/bin/activate";
			my $virtualenv = findprog("virtualenv-3");
			$virtualenv = findprog("virtualenv-3.5") if (!$virtualenv);
			$virtualenv = findprog("virtualenv") if (!$virtualenv);
			$virtualenv = "virtualenv" if (!$virtualenv);

			printf "\t$virtualenv $virtenv_dir\n";
			printf "\t. $rec_activate\n";
			printf "\tpip install -r $requirement_file\n";

			$need++ if (!$rec_sphinx_upgrade);
		}
	}
	printf "\n";

	print "All optional dependencies are met.\n" if (!$optional);

	if ($need == 1) {
		die "Can't build as $need mandatory dependency is missing";
	} elsif ($need) {
		die "Can't build as $need mandatory dependencies are missing";
	}

	print "Needed package dependencies are met.\n";
}

#
# Main
#

while (@ARGV) {
	my $arg = shift(@ARGV);

	if ($arg eq "--no-virtualenv") {
		$virtualenv = 0;
	} elsif ($arg eq "--no-pdf"){
		$pdf = 0;
	} elsif ($arg eq "--version-check"){
		$version_check = 1;
	} else {
		print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf> <--version-check>\n\n";
		print "Where:\n";
		print "\t--no-virtualenv\t- Recommend installing Sphinx instead of using a virtualenv\n";
		print "\t--version-check\t- if version is compatible, don't check for missing dependencies\n";
		print "\t--no-pdf\t- don't check for dependencies required to build PDF docs\n\n";
		exit -1;
	}
}

#
# Determine the system type. There's no standard unique way that would
# work with all distros with a minimal package install. So, several
# methods are used here.
#
# By default, it will use lsb_release function. If not available, it will
# fail back to reading the known different places where the distro name
# is stored
#

$system_release = qx(lsb_release -d) if which("lsb_release");
$system_release =~ s/Description:\s*// if ($system_release);
$system_release = catcheck("/etc/system-release") if !$system_release;
$system_release = catcheck("/etc/redhat-release") if !$system_release;
$system_release = catcheck("/etc/lsb-release") if !$system_release;
$system_release = catcheck("/etc/gentoo-release") if !$system_release;
$system_release = catcheck("/etc/issue") if !$system_release;
$system_release =~ s/\s+$//;

check_needs;
Commit	Line	Data
24071ac1	1	#!/usr/bin/perl
c942fddf	2	# SPDX-License-Identifier: GPL-2.0-or-later
24071ac1 MCC	3	use strict;
24071ac1 MCC	4
44f42165	5	# Copyright (c) 2017-2019 Mauro Carvalho Chehab <mchehab@kernel.org>
24071ac1	6	#
24071ac1	7
8c69b77a MR	8	my $prefix = "./";
	9	$prefix = "$ENV{'srctree'}/" if ($ENV{'srctree'});
	10
	11	my $conf = $prefix . "Documentation/conf.py";
	12	my $requirement_file = $prefix . "Documentation/sphinx/requirements.txt";
44f42165	13	my $virtenv_prefix = "sphinx_";
5be33182	14
24071ac1 MCC	15	#
	16	# Static vars
	17	#
	18
	19	my %missing;
	20	my $system_release;
	21	my $need = 0;
	22	my $optional = 0;
	23	my $need_symlink = 0;
	24	my $need_sphinx = 0;
77d09ad9	25	my $rec_sphinx_upgrade = 0;
24071ac1	26	my $install = "";
44f42165 MCC	27	my $virtenv_dir = "";
44f42165 MCC	28	my $min_version;
24071ac1 MCC	29
	30	#
	31	# Command line arguments
	32	#
	33
	34	my $pdf = 1;
	35	my $virtualenv = 1;
9b88ad54	36	my $version_check = 0;
24071ac1 MCC	37
	38	#
	39	# List of required texlive packages on Fedora and OpenSuse
	40	#
	41
	42	my %texlive = (
24071ac1 MCC	43	'amsfonts.sty' => 'texlive-amsfonts',
	44	'amsmath.sty' => 'texlive-amsmath',
	45	'amssymb.sty' => 'texlive-amsfonts',
	46	'amsthm.sty' => 'texlive-amscls',
	47	'anyfontsize.sty' => 'texlive-anyfontsize',
	48	'atbegshi.sty' => 'texlive-oberdiek',
	49	'bm.sty' => 'texlive-tools',
	50	'capt-of.sty' => 'texlive-capt-of',
	51	'cmap.sty' => 'texlive-cmap',
	52	'ecrm1000.tfm' => 'texlive-ec',
	53	'eqparbox.sty' => 'texlive-eqparbox',
	54	'eu1enc.def' => 'texlive-euenc',
	55	'fancybox.sty' => 'texlive-fancybox',
	56	'fancyvrb.sty' => 'texlive-fancyvrb',
	57	'float.sty' => 'texlive-float',
	58	'fncychap.sty' => 'texlive-fncychap',
	59	'footnote.sty' => 'texlive-mdwtools',
	60	'framed.sty' => 'texlive-framed',
	61	'luatex85.sty' => 'texlive-luatex85',
	62	'multirow.sty' => 'texlive-multirow',
	63	'needspace.sty' => 'texlive-needspace',
	64	'palatino.sty' => 'texlive-psnfss',
	65	'parskip.sty' => 'texlive-parskip',
	66	'polyglossia.sty' => 'texlive-polyglossia',
	67	'tabulary.sty' => 'texlive-tabulary',
	68	'threeparttable.sty' => 'texlive-threeparttable',
	69	'titlesec.sty' => 'texlive-titlesec',
	70	'ucs.sty' => 'texlive-ucs',
	71	'upquote.sty' => 'texlive-upquote',
	72	'wrapfig.sty' => 'texlive-wrapfig',
	73	);
	74
	75	#
	76	# Subroutines that checks if a feature exists
	77	#
	78
	79	sub check_missing(%)
	80	{
	81	my %map = %{$_[0]};
	82
	83	foreach my $prog (sort keys %missing) {
	84	my $is_optional = $missing{$prog};
	85
56e5a633 MCC	86	# At least on some LTS distros like CentOS 7, texlive doesn't
	87	# provide all packages we need. When such distros are
	88	# detected, we have to disable PDF output.
	89	#
	90	# So, we need to ignore the packages that distros would
	91	# need for LaTeX to work
	92	if ($is_optional == 2 && !$pdf) {
	93	$optional--;
	94	next;
	95	}
	96
24071ac1 MCC	97	if ($is_optional) {
	98	print "Warning: better to also install \"$prog\".\n";
	99	} else {
	100	print "ERROR: please install \"$prog\", otherwise, build won't work.\n";
	101	}
	102	if (defined($map{$prog})) {
	103	$install .= " " . $map{$prog};
	104	} else {
	105	$install .= " " . $prog;
	106	}
	107	}
	108
	109	$install =~ s/^\s//;
	110	}
	111
	112	sub add_package($$)
	113	{
	114	my $package = shift;
	115	my $is_optional = shift;
	116
	117	$missing{$package} = $is_optional;
	118	if ($is_optional) {
	119	$optional++;
	120	} else {
	121	$need++;
	122	}
	123	}
	124
	125	sub check_missing_file($$$)
	126	{
	127	my $file = shift;
	128	my $package = shift;
	129	my $is_optional = shift;
	130
	131	return if(-e $file);
	132
	133	add_package($package, $is_optional);
	134	}
	135
	136	sub findprog($)
	137	{
	138	foreach(split(/:/, $ENV{PATH})) {
	139	return "$_/$_[0]" if(-x "$_/$_[0]");
	140	}
	141	}
	142
	143	sub check_program($$)
	144	{
	145	my $prog = shift;
	146	my $is_optional = shift;
	147
	148	return if findprog($prog);
	149
	150	add_package($prog, $is_optional);
	151	}
	152
	153	sub check_perl_module($$)
	154	{
	155	my $prog = shift;
	156	my $is_optional = shift;
	157
	158	my $err = system("perl -M$prog -e 1 2>/dev/null /dev/null");
	159	return if ($err == 0);
	160
161	add_package($prog, $is_optional);
162	}
163
164	sub check_python_module($$)
165	{
166	my $prog = shift;
167	my $is_optional = shift;
168
169	my $err = system("python3 -c 'import $prog' 2>/dev/null /dev/null");
170	return if ($err == 0);
171	my $err = system("python -c 'import $prog' 2>/dev/null /dev/null");
172	return if ($err == 0);
173
174	add_package($prog, $is_optional);
175	}
176
177	sub check_rpm_missing($$)
178	{
179	my @pkgs = @{$_[0]};
180	my $is_optional = $_[1];
181
182	foreach my $prog(@pkgs) {
183	my $err = system("rpm -q '$prog' 2>/dev/null >/dev/null");
184	add_package($prog, $is_optional) if ($err);
185	}
186	}
187
188	sub check_pacman_missing($$)
189	{
190	my @pkgs = @{$_[0]};
191	my $is_optional = $_[1];
192
193	foreach my $prog(@pkgs) {
194	my $err = system("pacman -Q '$prog' 2>/dev/null >/dev/null");
195	add_package($prog, $is_optional) if ($err);
196	}
197	}
198
199	sub check_missing_tex($)
200	{
201	my $is_optional = shift;
202	my $kpsewhich = findprog("kpsewhich");
203
204	foreach my $prog(keys %texlive) {
205	my $package = $texlive{$prog};
206	if (!$kpsewhich) {
207	add_package($package, $is_optional);
208	next;
209	}
210	my $file = qx($kpsewhich $prog);
211	add_package($package, $is_optional) if ($file =~ /^\s*$/);
212	}
213	}
214
77d09ad9	215	sub get_sphinx_fname()
24071ac1	216	{
77d09ad9 MCC	217	my $fname = "sphinx-build";
77d09ad9 MCC	218	return $fname if findprog($fname);
24071ac1	219
77d09ad9 MCC	220	$fname = "sphinx-build-3";
77d09ad9 MCC	221	if (findprog($fname)) {
24071ac1	222	$need_symlink = 1;
77d09ad9	223	return $fname;
24071ac1 MCC	224	}
	225
	226	if ($virtualenv) {
800d408a MCC	227	my $prog = findprog("virtualenv-3");
	228	$prog = findprog("virtualenv-3.5") if (!$prog);
	229
	230	check_program("virtualenv", 0) if (!$prog);
24071ac1 MCC	231	$need_sphinx = 1;
	232	} else {
	233	add_package("python-sphinx", 0);
	234	}
77d09ad9 MCC	235
	236	return "";
	237	}
	238
	239	sub check_sphinx()
	240	{
77d09ad9 MCC	241	my $rec_version;
	242	my $cur_version;
	243
	244	open IN, $conf or die "Can't open $conf";
	245	while (<IN>) {
	246	if (m/^\sneeds_sphinx\s=\s*[\'\"]([\d\.]+)[\'\"]/) {
	247	$min_version=$1;
	248	last;
	249	}
	250	}
	251	close IN;
	252
	253	die "Can't get needs_sphinx version from $conf" if (!$min_version);
	254
	255	open IN, $requirement_file or die "Can't open $requirement_file";
	256	while (<IN>) {
	257	if (m/^\sSphinx\s==\s*([\d\.]+)$/) {
	258	$rec_version=$1;
	259	last;
	260	}
	261	}
	262	close IN;
	263
	264	die "Can't get recommended sphinx version from $requirement_file" if (!$min_version);
	265
44f42165	266	$virtenv_dir = $virtenv_prefix . $rec_version;
77d09ad9 MCC	267
	268	my $sphinx = get_sphinx_fname();
	269	return if ($sphinx eq "");
	270
	271	open IN, "$sphinx --version 2>&1 \|" or die "$sphinx returned an error";
	272	while (<IN>) {
	273	if (m/^\s*sphinx-build\s+([\d\.]+)$/) {
	274	$cur_version=$1;
	275	last;
	276	}
	277	# Sphinx 1.2.x uses a different format
	278	if (m/^\sSphinx.\s+([\d\.]+)$/) {
	279	$cur_version=$1;
	280	last;
	281	}
	282	}
	283	close IN;
	284
	285	die "$sphinx didn't return its version" if (!$cur_version);
	286
77d09ad9	287	if ($cur_version lt $min_version) {
9b88ad54 MCC	288	printf "ERROR: Sphinx version is %s. It should be >= %s (recommended >= %s)\n",
9b88ad54 MCC	289	$cur_version, $min_version, $rec_version;;
77d09ad9 MCC	290	$need_sphinx = 1;
	291	return;
	292	}
	293
	294	if ($cur_version lt $rec_version) {
9b88ad54	295	printf "Sphinx version %s\n", $cur_version;
77d09ad9	296	print "Warning: It is recommended at least Sphinx version $rec_version.\n";
77d09ad9	297	$rec_sphinx_upgrade = 1;
9b88ad54	298	return;
77d09ad9	299	}
9b88ad54 MCC	300
	301	# On version check mode, just assume Sphinx has all mandatory deps
	302	exit (0) if ($version_check);
24071ac1 MCC	303	}
	304
	305	#
	306	# Ancillary subroutines
	307	#
	308
	309	sub catcheck($)
	310	{
	311	my $res = "";
	312	$res = qx(cat $_[0]) if (-r $_[0]);
	313	return $res;
	314	}
	315
	316	sub which($)
	317	{
	318	my $file = shift;
	319	my @path = split ":", $ENV{PATH};
	320
	321	foreach my $dir(@path) {
	322	my $name = $dir.'/'.$file;
	323	return $name if (-x $name );
	324	}
	325	return undef;
	326	}
	327
	328	#
	329	# Subroutines that check distro-specific hints
	330	#
	331
	332	sub give_debian_hints()
	333	{
	334	my %map = (
	335	"python-sphinx" => "python3-sphinx",
	336	"sphinx_rtd_theme" => "python3-sphinx-rtd-theme",
	337	"virtualenv" => "virtualenv",
24071ac1 MCC	338	"dot" => "graphviz",
	339	"convert" => "imagemagick",
	340	"Pod::Usage" => "perl-modules",
	341	"xelatex" => "texlive-xetex",
8e7d5d15	342	"rsvg-convert" => "librsvg2-bin",
24071ac1 MCC	343	);
	344
	345	if ($pdf) {
	346	check_missing_file("/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf",
56e5a633	347	"fonts-dejavu", 2);
24071ac1 MCC	348	}
24071ac1 MCC	349
56e5a633	350	check_program("dvipng", 2) if ($pdf);
24071ac1 MCC	351	check_missing(\%map);
	352
	353	return if (!$need && !$optional);
	354	printf("You should run:\n\n\tsudo apt-get install $install\n");
	355	}
	356
	357	sub give_redhat_hints()
	358	{
	359	my %map = (
	360	"python-sphinx" => "python3-sphinx",
	361	"sphinx_rtd_theme" => "python3-sphinx_rtd_theme",
	362	"virtualenv" => "python3-virtualenv",
24071ac1 MCC	363	"dot" => "graphviz",
	364	"convert" => "ImageMagick",
	365	"Pod::Usage" => "perl-Pod-Usage",
	366	"xelatex" => "texlive-xetex-bin",
8e7d5d15	367	"rsvg-convert" => "librsvg2-tools",
24071ac1 MCC	368	);
24071ac1 MCC	369
5d88953c MCC	370	my @fedora26_opt_pkgs = (
	371	"graphviz-gd", # Fedora 26: needed for PDF support
	372	);
	373
24071ac1 MCC	374	my @fedora_tex_pkgs = (
	375	"texlive-collection-fontsrecommended",
	376	"texlive-collection-latex",
	377	"dejavu-sans-fonts",
	378	"dejavu-serif-fonts",
	379	"dejavu-sans-mono-fonts",
	380	);
	381
9b756a9d MCC	382	#
	383	# Checks valid for RHEL/CentOS version 7.x.
	384	#
56e5a633 MCC	385	my $old = 0;
	386	my $rel;
	387	$rel = $1 if ($system_release =~ /release\s+(\d+)/);
	388
b308467c	389	if (!($system_release =~ /Fedora/)) {
9b756a9d	390	$map{"virtualenv"} = "python-virtualenv";
9b756a9d	391
56e5a633 MCC	392	if ($rel && $rel < 8) {
	393	$old = 1;
	394	$pdf = 0;
5d88953c	395
56e5a633 MCC	396	printf("Note: texlive packages on RHEL/CENTOS <= 7 are incomplete. Can't support PDF output\n");
	397	printf("If you want to build PDF, please read:\n");
	398	printf("\thttps://www.systutorials.com/241660/how-to-install-tex-live-on-centos-7-linux/\n");
	399	}
	400	} else {
	401	if ($rel && $rel < 26) {
	402	$old = 1;
	403	}
	404	}
	405	if (!$rel) {
	406	printf("Couldn't identify release number\n");
	407	$old = 1;
	408	$pdf = 0;
	409	}
5d88953c	410
56e5a633 MCC	411	check_rpm_missing(\@fedora26_opt_pkgs, 2) if ($pdf && !$old);
	412	check_rpm_missing(\@fedora_tex_pkgs, 2) if ($pdf);
	413	check_missing_tex(2) if ($pdf);
24071ac1 MCC	414	check_missing(\%map);
	415
	416	return if (!$need && !$optional);
9b756a9d	417
56e5a633	418	if (!$old) {
9b756a9d MCC	419	# dnf, for Fedora 18+
	420	printf("You should run:\n\n\tsudo dnf install -y $install\n");
	421	} else {
	422	# yum, for RHEL (and clones) or Fedora version < 18
	423	printf("You should run:\n\n\tsudo yum install -y $install\n");
	424	}
24071ac1 MCC	425	}
	426
	427	sub give_opensuse_hints()
	428	{
	429	my %map = (
	430	"python-sphinx" => "python3-sphinx",
	431	"sphinx_rtd_theme" => "python3-sphinx_rtd_theme",
	432	"virtualenv" => "python3-virtualenv",
24071ac1 MCC	433	"dot" => "graphviz",
	434	"convert" => "ImageMagick",
	435	"Pod::Usage" => "perl-Pod-Usage",
	436	"xelatex" => "texlive-xetex-bin",
8e7d5d15	437	"rsvg-convert" => "rsvg-view",
24071ac1 MCC	438	);
	439
	440	my @suse_tex_pkgs = (
	441	"texlive-babel-english",
	442	"texlive-caption",
	443	"texlive-colortbl",
	444	"texlive-courier",
	445	"texlive-dvips",
	446	"texlive-helvetic",
	447	"texlive-makeindex",
	448	"texlive-metafont",
	449	"texlive-metapost",
	450	"texlive-palatino",
	451	"texlive-preview",
	452	"texlive-times",
	453	"texlive-zapfchan",
	454	"texlive-zapfding",
	455	);
	456
353290a9 MCC	457	$map{"latexmk"} = "texlive-latexmk-bin";
353290a9 MCC	458
56e5a633 MCC	459	check_rpm_missing(\@suse_tex_pkgs, 2) if ($pdf);
56e5a633 MCC	460	check_missing_tex(2) if ($pdf);
24071ac1 MCC	461	check_missing(\%map);
	462
	463	return if (!$need && !$optional);
	464	printf("You should run:\n\n\tsudo zypper install --no-recommends $install\n");
	465	}
	466
800d408a MCC	467	sub give_mageia_hints()
	468	{
	469	my %map = (
	470	"python-sphinx" => "python3-sphinx",
	471	"sphinx_rtd_theme" => "python3-sphinx_rtd_theme",
	472	"virtualenv" => "python3-virtualenv",
800d408a MCC	473	"dot" => "graphviz",
	474	"convert" => "ImageMagick",
	475	"Pod::Usage" => "perl-Pod-Usage",
	476	"xelatex" => "texlive",
	477	"rsvg-convert" => "librsvg2-tools",
	478	);
	479
	480	my @tex_pkgs = (
	481	"texlive-fontsextra",
	482	);
	483
353290a9 MCC	484	$map{"latexmk"} = "texlive-collection-basic";
353290a9 MCC	485
56e5a633	486	check_rpm_missing(\@tex_pkgs, 2) if ($pdf);
800d408a MCC	487	check_missing(\%map);
	488
	489	return if (!$need && !$optional);
	490	printf("You should run:\n\n\tsudo urpmi $install\n");
	491	}
	492
24071ac1 MCC	493	sub give_arch_linux_hints()
	494	{
	495	my %map = (
	496	"sphinx_rtd_theme" => "python-sphinx_rtd_theme",
	497	"virtualenv" => "python-virtualenv",
24071ac1 MCC	498	"dot" => "graphviz",
	499	"convert" => "imagemagick",
	500	"xelatex" => "texlive-bin",
8e7d5d15	501	"rsvg-convert" => "extra/librsvg",
24071ac1 MCC	502	);
	503
	504	my @archlinux_tex_pkgs = (
	505	"texlive-core",
	506	"texlive-latexextra",
	507	"ttf-dejavu",
	508	);
56e5a633 MCC	509	check_pacman_missing(\@archlinux_tex_pkgs, 2) if ($pdf);
56e5a633 MCC	510
24071ac1 MCC	511	check_missing(\%map);
	512
	513	return if (!$need && !$optional);
	514	printf("You should run:\n\n\tsudo pacman -S $install\n");
	515	}
	516
	517	sub give_gentoo_hints()
	518	{
	519	my %map = (
	520	"sphinx_rtd_theme" => "dev-python/sphinx_rtd_theme",
	521	"virtualenv" => "dev-python/virtualenv",
24071ac1 MCC	522	"dot" => "media-gfx/graphviz",
	523	"convert" => "media-gfx/imagemagick",
	524	"xelatex" => "dev-texlive/texlive-xetex media-fonts/dejavu",
8e7d5d15	525	"rsvg-convert" => "gnome-base/librsvg",
24071ac1 MCC	526	);
	527
	528	check_missing_file("/usr/share/fonts/dejavu/DejaVuSans.ttf",
56e5a633	529	"media-fonts/dejavu", 2) if ($pdf);
24071ac1 MCC	530
	531	check_missing(\%map);
	532
	533	return if (!$need && !$optional);
bba1e4cb MCC	534
	535	printf("You should run:\n\n");
	536	printf("\tsudo su -c 'echo \"media-gfx/imagemagick svg png\" > /etc/portage/package.use/imagemagick'\n");
	537	printf("\tsudo su -c 'echo \"media-gfx/graphviz cairo pdf\" > /etc/portage/package.use/graphviz'\n");
	538	printf("\tsudo emerge --ask $install\n");
	539
24071ac1 MCC	540	}
	541
	542	sub check_distros()
	543	{
	544	# Distro-specific hints
	545	if ($system_release =~ /Red Hat Enterprise Linux/) {
	546	give_redhat_hints;
	547	return;
	548	}
9b756a9d MCC	549	if ($system_release =~ /CentOS/) {
	550	give_redhat_hints;
	551	return;
	552	}
	553	if ($system_release =~ /Scientific Linux/) {
	554	give_redhat_hints;
	555	return;
	556	}
	557	if ($system_release =~ /Oracle Linux Server/) {
	558	give_redhat_hints;
	559	return;
	560	}
24071ac1 MCC	561	if ($system_release =~ /Fedora/) {
	562	give_redhat_hints;
	563	return;
	564	}
	565	if ($system_release =~ /Ubuntu/) {
	566	give_debian_hints;
	567	return;
	568	}
	569	if ($system_release =~ /Debian/) {
	570	give_debian_hints;
	571	return;
	572	}
	573	if ($system_release =~ /openSUSE/) {
	574	give_opensuse_hints;
	575	return;
	576	}
800d408a MCC	577	if ($system_release =~ /Mageia/) {
	578	give_mageia_hints;
	579	return;
	580	}
24071ac1 MCC	581	if ($system_release =~ /Arch Linux/) {
	582	give_arch_linux_hints;
	583	return;
	584	}
	585	if ($system_release =~ /Gentoo/) {
	586	give_gentoo_hints;
	587	return;
	588	}
	589
	590	#
	591	# Fall-back to generic hint code for other distros
	592	# That's far from ideal, specially for LaTeX dependencies.
	593	#
	594	my %map = (
	595	"sphinx-build" => "sphinx"
	596	);
56e5a633	597	check_missing_tex(2) if ($pdf);
24071ac1 MCC	598	check_missing(\%map);
	599	print "I don't know distro $system_release.\n";
	600	print "So, I can't provide you a hint with the install procedure.\n";
	601	print "There are likely missing dependencies.\n";
	602	}
	603
	604	#
	605	# Common dependencies
	606	#
	607
	608	sub check_needs()
	609	{
9b88ad54 MCC	610	# Check for needed programs/tools
	611	check_sphinx();
	612
24071ac1	613	if ($system_release) {
9b88ad54	614	print "Detected OS: $system_release.\n\n";
24071ac1	615	} else {
9b88ad54	616	print "Unknown OS\n\n";
9b756a9d MCC	617	}
9b756a9d MCC	618
9b88ad54 MCC	619	print "To upgrade Sphinx, use:\n\n" if ($rec_sphinx_upgrade);
9b88ad54 MCC	620
24071ac1	621	# Check for needed programs/tools
24071ac1 MCC	622	check_perl_module("Pod::Usage", 0);
	623	check_program("make", 0);
	624	check_program("gcc", 0);
	625	check_python_module("sphinx_rtd_theme", 1) if (!$virtualenv);
24071ac1 MCC	626	check_program("dot", 1);
24071ac1 MCC	627	check_program("convert", 1);
56e5a633 MCC	628
	629	# Extra PDF files - should use 2 for is_optional
	630	check_program("xelatex", 2) if ($pdf);
	631	check_program("rsvg-convert", 2) if ($pdf);
	632	check_program("latexmk", 2) if ($pdf);
24071ac1 MCC	633
	634	check_distros();
	635
	636	if ($need_symlink) {
	637	printf "\tsudo ln -sf %s /usr/bin/sphinx-build\n\n",
	638	which("sphinx-build-3");
	639	}
77d09ad9	640	if ($need_sphinx \|\| $rec_sphinx_upgrade) {
44f42165	641	my $min_activate = "$ENV{'PWD'}/${virtenv_prefix}${min_version}/bin/activate";
9b88ad54	642	my @activates = glob "$ENV{'PWD'}/${virtenv_prefix}*/bin/activate";
44f42165	643
9b88ad54	644	@activates = sort {$b cmp $a} @activates;
44f42165	645
9b88ad54 MCC	646	if ($need_sphinx && scalar @activates > 0 && $activates[0] ge $min_activate) {
9b88ad54 MCC	647	printf "\nNeed to activate a compatible Sphinx version on virtualenv with:\n";
44f42165	648	printf "\t. $activates[0]\n";
9b88ad54	649	exit (1);
5be33182	650	} else {
44f42165	651	my $rec_activate = "$virtenv_dir/bin/activate";
5be33182	652	my $virtualenv = findprog("virtualenv-3");
800d408a	653	$virtualenv = findprog("virtualenv-3.5") if (!$virtualenv);
5be33182 MCC	654	$virtualenv = findprog("virtualenv") if (!$virtualenv);
	655	$virtualenv = "virtualenv" if (!$virtualenv);
	656
	657	printf "\t$virtualenv $virtenv_dir\n";
44f42165	658	printf "\t. $rec_activate\n";
fb947f3f	659	printf "\tpip install -r $requirement_file\n";
77d09ad9 MCC	660
77d09ad9 MCC	661	$need++ if (!$rec_sphinx_upgrade);
5be33182	662	}
24071ac1 MCC	663	}
	664	printf "\n";
	665
54002b56	666	print "All optional dependencies are met.\n" if (!$optional);
24071ac1 MCC	667
	668	if ($need == 1) {
	669	die "Can't build as $need mandatory dependency is missing";
	670	} elsif ($need) {
	671	die "Can't build as $need mandatory dependencies are missing";
	672	}
	673
	674	print "Needed package dependencies are met.\n";
	675	}
	676
	677	#
	678	# Main
	679	#
	680
	681	while (@ARGV) {
	682	my $arg = shift(@ARGV);
	683
	684	if ($arg eq "--no-virtualenv") {
	685	$virtualenv = 0;
	686	} elsif ($arg eq "--no-pdf"){
	687	$pdf = 0;
9b88ad54 MCC	688	} elsif ($arg eq "--version-check"){
9b88ad54 MCC	689	$version_check = 1;
24071ac1	690	} else {
9b88ad54 MCC	691	print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf> <--version-check>\n\n";
	692	print "Where:\n";
	693	print "\t--no-virtualenv\t- Recommend installing Sphinx instead of using a virtualenv\n";
	694	print "\t--version-check\t- if version is compatible, don't check for missing dependencies\n";
	695	print "\t--no-pdf\t- don't check for dependencies required to build PDF docs\n\n";
24071ac1 MCC	696	exit -1;
	697	}
	698	}
	699
	700	#
	701	# Determine the system type. There's no standard unique way that would
	702	# work with all distros with a minimal package install. So, several
	703	# methods are used here.
	704	#
	705	# By default, it will use lsb_release function. If not available, it will
	706	# fail back to reading the known different places where the distro name
	707	# is stored
	708	#
	709
	710	$system_release = qx(lsb_release -d) if which("lsb_release");
	711	$system_release =~ s/Description:\s*// if ($system_release);
	712	$system_release = catcheck("/etc/system-release") if !$system_release;
	713	$system_release = catcheck("/etc/redhat-release") if !$system_release;
	714	$system_release = catcheck("/etc/lsb-release") if !$system_release;
	715	$system_release = catcheck("/etc/gentoo-release") if !$system_release;
	716	$system_release = catcheck("/etc/issue") if !$system_release;
	717	$system_release =~ s/\s+$//;
	718
	719	check_needs;