1#!/usr/bin/perl 2use strict; 3 4# Copyright (c) 2017 Mauro Carvalho Chehab <mchehab@kernel.org> 5# 6# This program is free software; you can redistribute it and/or 7# modify it under the terms of the GNU General Public License 8# as published by the Free Software Foundation; either version 2 9# of the License, or (at your option) any later version. 10# 11# This program is distributed in the hope that it will be useful, 12# but WITHOUT ANY WARRANTY; without even the implied warranty of 13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14# GNU General Public License for more details. 15 16my $virtenv_dir = "sphinx_1.4"; 17my $requirement_file = "Documentation/sphinx/requirements.txt"; 18 19# 20# Static vars 21# 22 23my %missing; 24my $system_release; 25my $need = 0; 26my $optional = 0; 27my $need_symlink = 0; 28my $need_sphinx = 0; 29my $install = ""; 30 31# 32# Command line arguments 33# 34 35my $pdf = 1; 36my $virtualenv = 1; 37 38# 39# List of required texlive packages on Fedora and OpenSuse 40# 41 42my %texlive = ( 43 'adjustbox.sty' => 'texlive-adjustbox', 44 'amsfonts.sty' => 'texlive-amsfonts', 45 'amsmath.sty' => 'texlive-amsmath', 46 'amssymb.sty' => 'texlive-amsfonts', 47 'amsthm.sty' => 'texlive-amscls', 48 'anyfontsize.sty' => 'texlive-anyfontsize', 49 'atbegshi.sty' => 'texlive-oberdiek', 50 'bm.sty' => 'texlive-tools', 51 'capt-of.sty' => 'texlive-capt-of', 52 'cmap.sty' => 'texlive-cmap', 53 'ecrm1000.tfm' => 'texlive-ec', 54 'eqparbox.sty' => 'texlive-eqparbox', 55 'eu1enc.def' => 'texlive-euenc', 56 'fancybox.sty' => 'texlive-fancybox', 57 'fancyvrb.sty' => 'texlive-fancyvrb', 58 'float.sty' => 'texlive-float', 59 'fncychap.sty' => 'texlive-fncychap', 60 'footnote.sty' => 'texlive-mdwtools', 61 'framed.sty' => 'texlive-framed', 62 'luatex85.sty' => 'texlive-luatex85', 63 'multirow.sty' => 'texlive-multirow', 64 'needspace.sty' => 'texlive-needspace', 65 'palatino.sty' => 'texlive-psnfss', 66 'parskip.sty' => 'texlive-parskip', 67 'polyglossia.sty' => 'texlive-polyglossia', 68 'tabulary.sty' => 'texlive-tabulary', 69 'threeparttable.sty' => 'texlive-threeparttable', 70 'titlesec.sty' => 'texlive-titlesec', 71 'ucs.sty' => 'texlive-ucs', 72 'upquote.sty' => 'texlive-upquote', 73 'wrapfig.sty' => 'texlive-wrapfig', 74); 75 76# 77# Subroutines that checks if a feature exists 78# 79 80sub check_missing(%) 81{ 82 my %map = %{$_[0]}; 83 84 foreach my $prog (sort keys %missing) { 85 my $is_optional = $missing{$prog}; 86 87 if ($is_optional) { 88 print "Warning: better to also install \"$prog\".\n"; 89 } else { 90 print "ERROR: please install \"$prog\", otherwise, build won't work.\n"; 91 } 92 if (defined($map{$prog})) { 93 $install .= " " . $map{$prog}; 94 } else { 95 $install .= " " . $prog; 96 } 97 } 98 99 $install =~ s/^\s//; 100} 101 102sub add_package($$) 103{ 104 my $package = shift; 105 my $is_optional = shift; 106 107 $missing{$package} = $is_optional; 108 if ($is_optional) { 109 $optional++; 110 } else { 111 $need++; 112 } 113} 114 115sub check_missing_file($$$) 116{ 117 my $file = shift; 118 my $package = shift; 119 my $is_optional = shift; 120 121 return if(-e $file); 122 123 add_package($package, $is_optional); 124} 125 126sub findprog($) 127{ 128 foreach(split(/:/, $ENV{PATH})) { 129 return "$_/$_[0]" if(-x "$_/$_[0]"); 130 } 131} 132 133sub check_program($$) 134{ 135 my $prog = shift; 136 my $is_optional = shift; 137 138 return if findprog($prog); 139 140 add_package($prog, $is_optional); 141} 142 143sub check_perl_module($$) 144{ 145 my $prog = shift; 146 my $is_optional = shift; 147 148 my $err = system("perl -M$prog -e 1 2>/dev/null /dev/null"); 149 return if ($err == 0); 150 151 add_package($prog, $is_optional); 152} 153 154sub check_python_module($$) 155{ 156 my $prog = shift; 157 my $is_optional = shift; 158 159 my $err = system("python3 -c 'import $prog' 2>/dev/null /dev/null"); 160 return if ($err == 0); 161 my $err = system("python -c 'import $prog' 2>/dev/null /dev/null"); 162 return if ($err == 0); 163 164 add_package($prog, $is_optional); 165} 166 167sub check_rpm_missing($$) 168{ 169 my @pkgs = @{$_[0]}; 170 my $is_optional = $_[1]; 171 172 foreach my $prog(@pkgs) { 173 my $err = system("rpm -q '$prog' 2>/dev/null >/dev/null"); 174 add_package($prog, $is_optional) if ($err); 175 } 176} 177 178sub check_pacman_missing($$) 179{ 180 my @pkgs = @{$_[0]}; 181 my $is_optional = $_[1]; 182 183 foreach my $prog(@pkgs) { 184 my $err = system("pacman -Q '$prog' 2>/dev/null >/dev/null"); 185 add_package($prog, $is_optional) if ($err); 186 } 187} 188 189sub check_missing_tex($) 190{ 191 my $is_optional = shift; 192 my $kpsewhich = findprog("kpsewhich"); 193 194 foreach my $prog(keys %texlive) { 195 my $package = $texlive{$prog}; 196 if (!$kpsewhich) { 197 add_package($package, $is_optional); 198 next; 199 } 200 my $file = qx($kpsewhich $prog); 201 add_package($package, $is_optional) if ($file =~ /^\s*$/); 202 } 203} 204 205sub check_sphinx() 206{ 207 return if findprog("sphinx-build"); 208 209 if (findprog("sphinx-build-3")) { 210 $need_symlink = 1; 211 return; 212 } 213 214 if ($virtualenv) { 215 check_program("virtualenv", 0) if (!findprog("virtualenv-3")); 216 check_program("pip", 0) if (!findprog("pip3")); 217 $need_sphinx = 1; 218 } else { 219 add_package("python-sphinx", 0); 220 } 221} 222 223# 224# Ancillary subroutines 225# 226 227sub catcheck($) 228{ 229 my $res = ""; 230 $res = qx(cat $_[0]) if (-r $_[0]); 231 return $res; 232} 233 234sub which($) 235{ 236 my $file = shift; 237 my @path = split ":", $ENV{PATH}; 238 239 foreach my $dir(@path) { 240 my $name = $dir.'/'.$file; 241 return $name if (-x $name ); 242 } 243 return undef; 244} 245 246# 247# Subroutines that check distro-specific hints 248# 249 250sub give_debian_hints() 251{ 252 my %map = ( 253 "python-sphinx" => "python3-sphinx", 254 "sphinx_rtd_theme" => "python3-sphinx-rtd-theme", 255 "virtualenv" => "virtualenv", 256 "pip" => "python3-pip", 257 "dot" => "graphviz", 258 "convert" => "imagemagick", 259 "Pod::Usage" => "perl-modules", 260 "xelatex" => "texlive-xetex", 261 ); 262 263 if ($pdf) { 264 check_missing_file("/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf", 265 "fonts-dejavu", 1); 266 } 267 268 check_program("dvipng", 1) if ($pdf); 269 check_missing(\%map); 270 271 return if (!$need && !$optional); 272 printf("You should run:\n\n\tsudo apt-get install $install\n"); 273} 274 275sub give_redhat_hints() 276{ 277 my %map = ( 278 "python-sphinx" => "python3-sphinx", 279 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme", 280 "virtualenv" => "python3-virtualenv", 281 "pip" => "python3-pip", 282 "dot" => "graphviz", 283 "convert" => "ImageMagick", 284 "Pod::Usage" => "perl-Pod-Usage", 285 "xelatex" => "texlive-xetex-bin", 286 ); 287 288 my @fedora26_opt_pkgs = ( 289 "graphviz-gd", # Fedora 26: needed for PDF support 290 ); 291 292 my @fedora_tex_pkgs = ( 293 "texlive-collection-fontsrecommended", 294 "texlive-collection-latex", 295 "dejavu-sans-fonts", 296 "dejavu-serif-fonts", 297 "dejavu-sans-mono-fonts", 298 ); 299 300 my $release; 301 302 $release = $1 if ($system_release =~ /Fedora\s+release\s+(\d+)/); 303 304 check_rpm_missing(\@fedora26_opt_pkgs, 1) if ($pdf && $release >= 26); 305 check_rpm_missing(\@fedora_tex_pkgs, 1) if ($pdf); 306 check_missing_tex(1) if ($pdf); 307 check_missing(\%map); 308 309 return if (!$need && !$optional); 310 printf("You should run:\n\n\tsudo dnf install -y $install\n"); 311} 312 313sub give_opensuse_hints() 314{ 315 my %map = ( 316 "python-sphinx" => "python3-sphinx", 317 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme", 318 "virtualenv" => "python3-virtualenv", 319 "pip" => "python3-pip", 320 "dot" => "graphviz", 321 "convert" => "ImageMagick", 322 "Pod::Usage" => "perl-Pod-Usage", 323 "xelatex" => "texlive-xetex-bin", 324 ); 325 326 my @suse_tex_pkgs = ( 327 "texlive-babel-english", 328 "texlive-caption", 329 "texlive-colortbl", 330 "texlive-courier", 331 "texlive-dvips", 332 "texlive-helvetic", 333 "texlive-makeindex", 334 "texlive-metafont", 335 "texlive-metapost", 336 "texlive-palatino", 337 "texlive-preview", 338 "texlive-times", 339 "texlive-zapfchan", 340 "texlive-zapfding", 341 ); 342 343 check_rpm_missing(\@suse_tex_pkgs, 1) if ($pdf); 344 check_missing_tex(1) if ($pdf); 345 check_missing(\%map); 346 347 return if (!$need && !$optional); 348 printf("You should run:\n\n\tsudo zypper install --no-recommends $install\n"); 349} 350 351sub give_arch_linux_hints() 352{ 353 my %map = ( 354 "sphinx_rtd_theme" => "python-sphinx_rtd_theme", 355 "virtualenv" => "python-virtualenv", 356 "pip" => "python-pip", 357 "dot" => "graphviz", 358 "convert" => "imagemagick", 359 "xelatex" => "texlive-bin", 360 ); 361 362 my @archlinux_tex_pkgs = ( 363 "texlive-core", 364 "texlive-latexextra", 365 "ttf-dejavu", 366 ); 367 check_pacman_missing(\@archlinux_tex_pkgs, 1) if ($pdf); 368 check_missing(\%map); 369 370 return if (!$need && !$optional); 371 printf("You should run:\n\n\tsudo pacman -S $install\n"); 372} 373 374sub give_gentoo_hints() 375{ 376 my %map = ( 377 "sphinx_rtd_theme" => "dev-python/sphinx_rtd_theme", 378 "virtualenv" => "dev-python/virtualenv", 379 "pip" => "dev-python/pip", 380 "dot" => "media-gfx/graphviz", 381 "convert" => "media-gfx/imagemagick", 382 "xelatex" => "dev-texlive/texlive-xetex media-fonts/dejavu", 383 ); 384 385 check_missing_file("/usr/share/fonts/dejavu/DejaVuSans.ttf", 386 "media-fonts/dejavu", 1) if ($pdf); 387 388 check_missing(\%map); 389 390 return if (!$need && !$optional); 391 printf("You should run:\n\n\tsudo emerge --ask $install\n"); 392} 393 394sub check_distros() 395{ 396 # Distro-specific hints 397 if ($system_release =~ /Red Hat Enterprise Linux/) { 398 give_redhat_hints; 399 return; 400 } 401 if ($system_release =~ /Fedora/) { 402 give_redhat_hints; 403 return; 404 } 405 if ($system_release =~ /Ubuntu/) { 406 give_debian_hints; 407 return; 408 } 409 if ($system_release =~ /Debian/) { 410 give_debian_hints; 411 return; 412 } 413 if ($system_release =~ /openSUSE/) { 414 give_opensuse_hints; 415 return; 416 } 417 if ($system_release =~ /Arch Linux/) { 418 give_arch_linux_hints; 419 return; 420 } 421 if ($system_release =~ /Gentoo/) { 422 give_gentoo_hints; 423 return; 424 } 425 426 # 427 # Fall-back to generic hint code for other distros 428 # That's far from ideal, specially for LaTeX dependencies. 429 # 430 my %map = ( 431 "sphinx-build" => "sphinx" 432 ); 433 check_missing_tex(1) if ($pdf); 434 check_missing(\%map); 435 print "I don't know distro $system_release.\n"; 436 print "So, I can't provide you a hint with the install procedure.\n"; 437 print "There are likely missing dependencies.\n"; 438} 439 440# 441# Common dependencies 442# 443 444sub check_needs() 445{ 446 if ($system_release) { 447 print "Checking if the needed tools for $system_release are available\n"; 448 } else { 449 print "Checking if the needed tools are present\n"; 450 } 451 452 # Check for needed programs/tools 453 check_sphinx(); 454 check_perl_module("Pod::Usage", 0); 455 check_program("make", 0); 456 check_program("gcc", 0); 457 check_python_module("sphinx_rtd_theme", 1) if (!$virtualenv); 458 check_program("xelatex", 1) if ($pdf); 459 check_program("dot", 1); 460 check_program("convert", 1); 461 462 check_distros(); 463 464 if ($need_symlink) { 465 printf "\tsudo ln -sf %s /usr/bin/sphinx-build\n\n", 466 which("sphinx-build-3"); 467 } 468 if ($need_sphinx) { 469 my $activate = "$virtenv_dir/bin/activate"; 470 if (-e "$ENV{'PWD'}/$activate") { 471 printf "\nNeed to activate virtualenv with:\n"; 472 printf "\t. $activate\n"; 473 } else { 474 my $virtualenv = findprog("virtualenv-3"); 475 $virtualenv = findprog("virtualenv") if (!$virtualenv); 476 $virtualenv = "virtualenv" if (!$virtualenv); 477 478 printf "\t$virtualenv $virtenv_dir\n"; 479 printf "\t. $activate\n"; 480 printf "\tpip install -r $requirement_file\n"; 481 $need++; 482 } 483 } 484 printf "\n"; 485 486 print "All optional dependenties are met.\n" if (!$optional); 487 488 if ($need == 1) { 489 die "Can't build as $need mandatory dependency is missing"; 490 } elsif ($need) { 491 die "Can't build as $need mandatory dependencies are missing"; 492 } 493 494 print "Needed package dependencies are met.\n"; 495} 496 497# 498# Main 499# 500 501while (@ARGV) { 502 my $arg = shift(@ARGV); 503 504 if ($arg eq "--no-virtualenv") { 505 $virtualenv = 0; 506 } elsif ($arg eq "--no-pdf"){ 507 $pdf = 0; 508 } else { 509 print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf>\n\n"; 510 exit -1; 511 } 512} 513 514# 515# Determine the system type. There's no standard unique way that would 516# work with all distros with a minimal package install. So, several 517# methods are used here. 518# 519# By default, it will use lsb_release function. If not available, it will 520# fail back to reading the known different places where the distro name 521# is stored 522# 523 524$system_release = qx(lsb_release -d) if which("lsb_release"); 525$system_release =~ s/Description:\s*// if ($system_release); 526$system_release = catcheck("/etc/system-release") if !$system_release; 527$system_release = catcheck("/etc/redhat-release") if !$system_release; 528$system_release = catcheck("/etc/lsb-release") if !$system_release; 529$system_release = catcheck("/etc/gentoo-release") if !$system_release; 530$system_release = catcheck("/etc/issue") if !$system_release; 531$system_release =~ s/\s+$//; 532 533check_needs; 534