1 #!/usr/bin/env perl 1 #!/usr/bin/env perl 2 # SPDX-License-Identifier: GPL-2.0-or-later << 3 use strict; 2 use strict; 4 3 5 # Copyright (c) 2017-2020 Mauro Carvalho Cheha< !! 4 # Copyright (c) 2017 Mauro Carvalho Chehab <mchehab@kernel.org> 6 # 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. 7 15 8 my $prefix = "./"; !! 16 my $virtenv_dir = "sphinx_1.4"; 9 $prefix = "$ENV{'srctree'}/" if ($ENV{'srctree !! 17 my $requirement_file = "Documentation/sphinx/requirements.txt"; 10 << 11 my $conf = $prefix . "Documentation/conf.py"; << 12 my $requirement_file = $prefix . "Documentatio << 13 my $virtenv_prefix = "sphinx_"; << 14 18 15 # 19 # 16 # Static vars 20 # Static vars 17 # 21 # 18 22 19 my %missing; 23 my %missing; 20 my $system_release; 24 my $system_release; 21 my $need = 0; 25 my $need = 0; 22 my $optional = 0; 26 my $optional = 0; 23 my $need_symlink = 0; 27 my $need_symlink = 0; 24 my $need_sphinx = 0; 28 my $need_sphinx = 0; 25 my $need_pip = 0; << 26 my $need_virtualenv = 0; << 27 my $rec_sphinx_upgrade = 0; << 28 my $verbose_warn_install = 1; << 29 my $install = ""; 29 my $install = ""; 30 my $virtenv_dir = ""; << 31 my $python_cmd = ""; << 32 my $activate_cmd; << 33 my $min_version; << 34 my $cur_version; << 35 my $rec_version = "3.4.3"; << 36 my $latest_avail_ver; << 37 30 38 # 31 # 39 # Command line arguments 32 # Command line arguments 40 # 33 # 41 34 42 my $pdf = 1; 35 my $pdf = 1; 43 my $virtualenv = 1; 36 my $virtualenv = 1; 44 my $version_check = 0; << 45 37 46 # 38 # 47 # List of required texlive packages on Fedora 39 # List of required texlive packages on Fedora and OpenSuse 48 # 40 # 49 41 50 my %texlive = ( 42 my %texlive = ( 51 'amsfonts.sty' => 'texlive-amsfo 43 'amsfonts.sty' => 'texlive-amsfonts', 52 'amsmath.sty' => 'texlive-amsma 44 'amsmath.sty' => 'texlive-amsmath', 53 'amssymb.sty' => 'texlive-amsfo 45 'amssymb.sty' => 'texlive-amsfonts', 54 'amsthm.sty' => 'texlive-amscl 46 'amsthm.sty' => 'texlive-amscls', 55 'anyfontsize.sty' => 'texlive-anyfo 47 'anyfontsize.sty' => 'texlive-anyfontsize', 56 'atbegshi.sty' => 'texlive-oberd 48 'atbegshi.sty' => 'texlive-oberdiek', 57 'bm.sty' => 'texlive-tools 49 'bm.sty' => 'texlive-tools', 58 'capt-of.sty' => 'texlive-capt- 50 'capt-of.sty' => 'texlive-capt-of', 59 'cmap.sty' => 'texlive-cmap' 51 'cmap.sty' => 'texlive-cmap', 60 'ecrm1000.tfm' => 'texlive-ec', 52 'ecrm1000.tfm' => 'texlive-ec', 61 'eqparbox.sty' => 'texlive-eqpar 53 'eqparbox.sty' => 'texlive-eqparbox', 62 'eu1enc.def' => 'texlive-euenc 54 'eu1enc.def' => 'texlive-euenc', 63 'fancybox.sty' => 'texlive-fancy 55 'fancybox.sty' => 'texlive-fancybox', 64 'fancyvrb.sty' => 'texlive-fancy 56 'fancyvrb.sty' => 'texlive-fancyvrb', 65 'float.sty' => 'texlive-float 57 'float.sty' => 'texlive-float', 66 'fncychap.sty' => 'texlive-fncyc 58 'fncychap.sty' => 'texlive-fncychap', 67 'footnote.sty' => 'texlive-mdwto 59 'footnote.sty' => 'texlive-mdwtools', 68 'framed.sty' => 'texlive-frame 60 'framed.sty' => 'texlive-framed', 69 'luatex85.sty' => 'texlive-luate 61 'luatex85.sty' => 'texlive-luatex85', 70 'multirow.sty' => 'texlive-multi 62 'multirow.sty' => 'texlive-multirow', 71 'needspace.sty' => 'texlive-needs 63 'needspace.sty' => 'texlive-needspace', 72 'palatino.sty' => 'texlive-psnfs 64 'palatino.sty' => 'texlive-psnfss', 73 'parskip.sty' => 'texlive-parsk 65 'parskip.sty' => 'texlive-parskip', 74 'polyglossia.sty' => 'texlive-polyg 66 'polyglossia.sty' => 'texlive-polyglossia', 75 'tabulary.sty' => 'texlive-tabul 67 'tabulary.sty' => 'texlive-tabulary', 76 'threeparttable.sty' => 'texlive-three 68 'threeparttable.sty' => 'texlive-threeparttable', 77 'titlesec.sty' => 'texlive-title 69 'titlesec.sty' => 'texlive-titlesec', 78 'ucs.sty' => 'texlive-ucs', 70 'ucs.sty' => 'texlive-ucs', 79 'upquote.sty' => 'texlive-upquo 71 'upquote.sty' => 'texlive-upquote', 80 'wrapfig.sty' => 'texlive-wrapf 72 'wrapfig.sty' => 'texlive-wrapfig', 81 'ctexhook.sty' => 'texlive-ctex' << 82 ); 73 ); 83 74 84 # 75 # 85 # Subroutines that checks if a feature exists 76 # Subroutines that checks if a feature exists 86 # 77 # 87 78 88 sub check_missing(%) 79 sub check_missing(%) 89 { 80 { 90 my %map = %{$_[0]}; 81 my %map = %{$_[0]}; 91 82 92 foreach my $prog (sort keys %missing) 83 foreach my $prog (sort keys %missing) { 93 my $is_optional = $missing{$pr 84 my $is_optional = $missing{$prog}; 94 85 95 # At least on some LTS distros !! 86 if ($is_optional) { 96 # provide all packages we need !! 87 print "Warning: better to also install \"$prog\".\n"; 97 # detected, we have to disable !! 88 } else { 98 # !! 89 print "ERROR: please install \"$prog\", otherwise, build won't work.\n"; 99 # So, we need to ignore the pa << 100 # need for LaTeX to work << 101 if ($is_optional == 2 && !$pdf << 102 $optional--; << 103 next; << 104 } << 105 << 106 if ($verbose_warn_install) { << 107 if ($is_optional) { << 108 print "Warning << 109 } else { << 110 print "ERROR: << 111 } << 112 } 90 } 113 if (defined($map{$prog})) { 91 if (defined($map{$prog})) { 114 $install .= " " . $map 92 $install .= " " . $map{$prog}; 115 } else { 93 } else { 116 $install .= " " . $pro 94 $install .= " " . $prog; 117 } 95 } 118 } 96 } 119 97 120 $install =~ s/^\s//; 98 $install =~ s/^\s//; 121 } 99 } 122 100 123 sub add_package($$) 101 sub add_package($$) 124 { 102 { 125 my $package = shift; 103 my $package = shift; 126 my $is_optional = shift; 104 my $is_optional = shift; 127 105 128 $missing{$package} = $is_optional; 106 $missing{$package} = $is_optional; 129 if ($is_optional) { 107 if ($is_optional) { 130 $optional++; 108 $optional++; 131 } else { 109 } else { 132 $need++; 110 $need++; 133 } 111 } 134 } 112 } 135 113 136 sub check_missing_file($$$) 114 sub check_missing_file($$$) 137 { 115 { 138 my $files = shift; !! 116 my $file = shift; 139 my $package = shift; 117 my $package = shift; 140 my $is_optional = shift; 118 my $is_optional = shift; 141 119 142 for (@$files) { !! 120 return if(-e $file); 143 return if(-e $_); << 144 } << 145 121 146 add_package($package, $is_optional); 122 add_package($package, $is_optional); 147 } 123 } 148 124 149 sub findprog($) 125 sub findprog($) 150 { 126 { 151 foreach(split(/:/, $ENV{PATH})) { 127 foreach(split(/:/, $ENV{PATH})) { 152 return "$_/$_[0]" if(-x "$_/$_ 128 return "$_/$_[0]" if(-x "$_/$_[0]"); 153 } 129 } 154 } 130 } 155 131 156 sub find_python_no_venv() << 157 { << 158 my $prog = shift; << 159 << 160 my $cur_dir = qx(pwd); << 161 $cur_dir =~ s/\s+$//; << 162 << 163 foreach my $dir (split(/:/, $ENV{PATH} << 164 next if ($dir =~ m,($cur_dir)/ << 165 return "$dir/python3" if(-x "$ << 166 } << 167 foreach my $dir (split(/:/, $ENV{PATH} << 168 next if ($dir =~ m,($cur_dir)/ << 169 return "$dir/python" if(-x "$d << 170 } << 171 return "python"; << 172 } << 173 << 174 sub check_program($$) 132 sub check_program($$) 175 { 133 { 176 my $prog = shift; 134 my $prog = shift; 177 my $is_optional = shift; 135 my $is_optional = shift; 178 136 179 return $prog if findprog($prog); !! 137 return if findprog($prog); 180 138 181 add_package($prog, $is_optional); 139 add_package($prog, $is_optional); 182 } 140 } 183 141 184 sub check_perl_module($$) 142 sub check_perl_module($$) 185 { 143 { 186 my $prog = shift; 144 my $prog = shift; 187 my $is_optional = shift; 145 my $is_optional = shift; 188 146 189 my $err = system("perl -M$prog -e 1 2> 147 my $err = system("perl -M$prog -e 1 2>/dev/null /dev/null"); 190 return if ($err == 0); 148 return if ($err == 0); 191 149 192 add_package($prog, $is_optional); 150 add_package($prog, $is_optional); 193 } 151 } 194 152 195 sub check_python_module($$) 153 sub check_python_module($$) 196 { 154 { 197 my $prog = shift; 155 my $prog = shift; 198 my $is_optional = shift; 156 my $is_optional = shift; 199 157 200 return if (!$python_cmd); !! 158 my $err = system("python3 -c 'import $prog' 2>/dev/null /dev/null"); 201 !! 159 return if ($err == 0); 202 my $err = system("$python_cmd -c 'impo !! 160 my $err = system("python -c 'import $prog' 2>/dev/null /dev/null"); 203 return if ($err == 0); 161 return if ($err == 0); 204 162 205 add_package($prog, $is_optional); 163 add_package($prog, $is_optional); 206 } 164 } 207 165 208 sub check_rpm_missing($$) 166 sub check_rpm_missing($$) 209 { 167 { 210 my @pkgs = @{$_[0]}; 168 my @pkgs = @{$_[0]}; 211 my $is_optional = $_[1]; 169 my $is_optional = $_[1]; 212 170 213 foreach my $prog(@pkgs) { 171 foreach my $prog(@pkgs) { 214 my $err = system("rpm -q '$pro 172 my $err = system("rpm -q '$prog' 2>/dev/null >/dev/null"); 215 add_package($prog, $is_optiona 173 add_package($prog, $is_optional) if ($err); 216 } 174 } 217 } 175 } 218 176 219 sub check_pacman_missing($$) 177 sub check_pacman_missing($$) 220 { 178 { 221 my @pkgs = @{$_[0]}; 179 my @pkgs = @{$_[0]}; 222 my $is_optional = $_[1]; 180 my $is_optional = $_[1]; 223 181 224 foreach my $prog(@pkgs) { 182 foreach my $prog(@pkgs) { 225 my $err = system("pacman -Q '$ 183 my $err = system("pacman -Q '$prog' 2>/dev/null >/dev/null"); 226 add_package($prog, $is_optiona 184 add_package($prog, $is_optional) if ($err); 227 } 185 } 228 } 186 } 229 187 230 sub check_missing_tex($) 188 sub check_missing_tex($) 231 { 189 { 232 my $is_optional = shift; 190 my $is_optional = shift; 233 my $kpsewhich = findprog("kpsewhich"); 191 my $kpsewhich = findprog("kpsewhich"); 234 192 235 foreach my $prog(keys %texlive) { 193 foreach my $prog(keys %texlive) { 236 my $package = $texlive{$prog}; 194 my $package = $texlive{$prog}; 237 if (!$kpsewhich) { 195 if (!$kpsewhich) { 238 add_package($package, 196 add_package($package, $is_optional); 239 next; 197 next; 240 } 198 } 241 my $file = qx($kpsewhich $prog 199 my $file = qx($kpsewhich $prog); 242 add_package($package, $is_opti 200 add_package($package, $is_optional) if ($file =~ /^\s*$/); 243 } 201 } 244 } 202 } 245 203 246 sub get_sphinx_fname() << 247 { << 248 my $fname = "sphinx-build"; << 249 return $fname if findprog($fname); << 250 << 251 $fname = "sphinx-build-3"; << 252 if (findprog($fname)) { << 253 $need_symlink = 1; << 254 return $fname; << 255 } << 256 << 257 return ""; << 258 } << 259 << 260 sub get_sphinx_version($) << 261 { << 262 my $cmd = shift; << 263 my $ver; << 264 << 265 open IN, "$cmd --version 2>&1 |"; << 266 while (<IN>) { << 267 if (m/^\s*sphinx-build\s+([\d\ << 268 $ver=$1; << 269 last; << 270 } << 271 # Sphinx 1.2.x uses a differen << 272 if (m/^\s*Sphinx.*\s+([\d\.]+) << 273 $ver=$1; << 274 last; << 275 } << 276 } << 277 close IN; << 278 return $ver; << 279 } << 280 << 281 sub check_sphinx() 204 sub check_sphinx() 282 { 205 { 283 open IN, $conf or die "Can't open $con !! 206 return if findprog("sphinx-build"); 284 while (<IN>) { << 285 if (m/^\s*needs_sphinx\s*=\s*[ << 286 $min_version=$1; << 287 last; << 288 } << 289 } << 290 close IN; << 291 << 292 die "Can't get needs_sphinx version fr << 293 << 294 $virtenv_dir = $virtenv_prefix . "late << 295 207 296 my $sphinx = get_sphinx_fname(); !! 208 if (findprog("sphinx-build-3")) { 297 if ($sphinx eq "") { !! 209 $need_symlink = 1; 298 $need_sphinx = 1; << 299 return; 210 return; 300 } 211 } 301 212 302 $cur_version = get_sphinx_version($sph !! 213 if ($virtualenv) { 303 die "$sphinx didn't return its version !! 214 my $prog = findprog("virtualenv-3"); >> 215 $prog = findprog("virtualenv-3.5") if (!$prog); 304 216 305 if ($cur_version lt $min_version) { !! 217 check_program("virtualenv", 0) if (!$prog); 306 printf "ERROR: Sphinx version << 307 $cur_version, $min_vers << 308 $need_sphinx = 1; 218 $need_sphinx = 1; 309 return; !! 219 } else { >> 220 add_package("python-sphinx", 0); 310 } 221 } 311 << 312 return if ($cur_version lt $rec_versio << 313 << 314 # On version check mode, just assume S << 315 exit (0) if ($version_check); << 316 } 222 } 317 223 318 # 224 # 319 # Ancillary subroutines 225 # Ancillary subroutines 320 # 226 # 321 227 322 sub catcheck($) 228 sub catcheck($) 323 { 229 { 324 my $res = ""; 230 my $res = ""; 325 $res = qx(cat $_[0]) if (-r $_[0]); 231 $res = qx(cat $_[0]) if (-r $_[0]); 326 return $res; 232 return $res; 327 } 233 } 328 234 329 sub which($) 235 sub which($) 330 { 236 { 331 my $file = shift; 237 my $file = shift; 332 my @path = split ":", $ENV{PATH}; 238 my @path = split ":", $ENV{PATH}; 333 239 334 foreach my $dir(@path) { 240 foreach my $dir(@path) { 335 my $name = $dir.'/'.$file; 241 my $name = $dir.'/'.$file; 336 return $name if (-x $name ); 242 return $name if (-x $name ); 337 } 243 } 338 return undef; 244 return undef; 339 } 245 } 340 246 341 # 247 # 342 # Subroutines that check distro-specific hints 248 # Subroutines that check distro-specific hints 343 # 249 # 344 250 345 sub give_debian_hints() 251 sub give_debian_hints() 346 { 252 { 347 my %map = ( 253 my %map = ( 348 "python-sphinx" => "py 254 "python-sphinx" => "python3-sphinx", 349 "yaml" => "py !! 255 "sphinx_rtd_theme" => "python3-sphinx-rtd-theme", 350 "ensurepip" => "py << 351 "virtualenv" => "vi 256 "virtualenv" => "virtualenv", 352 "dot" => "gr 257 "dot" => "graphviz", 353 "convert" => "im 258 "convert" => "imagemagick", 354 "Pod::Usage" => "pe 259 "Pod::Usage" => "perl-modules", 355 "xelatex" => "te 260 "xelatex" => "texlive-xetex", 356 "rsvg-convert" => "li 261 "rsvg-convert" => "librsvg2-bin", 357 ); 262 ); 358 263 359 if ($pdf) { 264 if ($pdf) { 360 check_missing_file(["/usr/shar !! 265 check_missing_file("/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf", 361 "texlive-la !! 266 "fonts-dejavu", 1); 362 << 363 check_missing_file(["/usr/shar << 364 "fonts-deja << 365 << 366 check_missing_file(["/usr/shar << 367 "/usr/shar << 368 "/usr/shar << 369 "fonts-noto << 370 } 267 } 371 268 372 check_program("dvipng", 2) if ($pdf); !! 269 check_program("dvipng", 1) if ($pdf); 373 check_missing(\%map); 270 check_missing(\%map); 374 271 375 return if (!$need && !$optional); 272 return if (!$need && !$optional); 376 printf("You should run:\n") if ($verbo !! 273 printf("You should run:\n\n\tsudo apt-get install $install\n"); 377 printf("\n\tsudo apt-get install $inst << 378 } 274 } 379 275 380 sub give_redhat_hints() 276 sub give_redhat_hints() 381 { 277 { 382 my %map = ( 278 my %map = ( 383 "python-sphinx" => "py 279 "python-sphinx" => "python3-sphinx", 384 "yaml" => "py !! 280 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme", 385 "virtualenv" => "py 281 "virtualenv" => "python3-virtualenv", 386 "dot" => "gr 282 "dot" => "graphviz", 387 "convert" => "Im 283 "convert" => "ImageMagick", 388 "Pod::Usage" => "pe 284 "Pod::Usage" => "perl-Pod-Usage", 389 "xelatex" => "te 285 "xelatex" => "texlive-xetex-bin", 390 "rsvg-convert" => "li 286 "rsvg-convert" => "librsvg2-tools", 391 ); 287 ); 392 288 393 my @fedora26_opt_pkgs = ( 289 my @fedora26_opt_pkgs = ( 394 "graphviz-gd", # Fedo 290 "graphviz-gd", # Fedora 26: needed for PDF support 395 ); 291 ); 396 292 397 my @fedora_tex_pkgs = ( 293 my @fedora_tex_pkgs = ( 398 "texlive-collection-fontsrecom 294 "texlive-collection-fontsrecommended", 399 "texlive-collection-latex", 295 "texlive-collection-latex", 400 "texlive-xecjk", << 401 "dejavu-sans-fonts", 296 "dejavu-sans-fonts", 402 "dejavu-serif-fonts", 297 "dejavu-serif-fonts", 403 "dejavu-sans-mono-fonts", 298 "dejavu-sans-mono-fonts", 404 ); 299 ); 405 300 406 # 301 # 407 # Checks valid for RHEL/CentOS version 302 # Checks valid for RHEL/CentOS version 7.x. 408 # 303 # 409 my $old = 0; << 410 my $rel; << 411 my $noto_sans_redhat = "google-noto-sa << 412 $rel = $1 if ($system_release =~ /rele << 413 << 414 if (!($system_release =~ /Fedora/)) { 304 if (!($system_release =~ /Fedora/)) { 415 $map{"virtualenv"} = "python-v 305 $map{"virtualenv"} = "python-virtualenv"; 416 << 417 if ($rel && $rel < 8) { << 418 $old = 1; << 419 $pdf = 0; << 420 << 421 printf("Note: texlive << 422 printf("If you want to << 423 printf("\thttps://www. << 424 } << 425 } else { << 426 if ($rel && $rel < 26) { << 427 $old = 1; << 428 } << 429 if ($rel && $rel >= 38) { << 430 $noto_sans_redhat = "g << 431 } << 432 } << 433 if (!$rel) { << 434 printf("Couldn't identify rele << 435 $old = 1; << 436 $pdf = 0; << 437 } 306 } 438 307 439 if ($pdf) { !! 308 my $release; 440 check_missing_file(["/usr/shar !! 309 441 "/usr/shar !! 310 $release = $1 if ($system_release =~ /Fedora\s+release\s+(\d+)/); 442 $noto_sans_ << 443 } << 444 311 445 check_rpm_missing(\@fedora26_opt_pkgs, !! 312 check_rpm_missing(\@fedora26_opt_pkgs, 1) if ($pdf && $release >= 26); 446 check_rpm_missing(\@fedora_tex_pkgs, 2 !! 313 check_rpm_missing(\@fedora_tex_pkgs, 1) if ($pdf); 447 check_missing_tex(2) if ($pdf); !! 314 check_missing_tex(1) if ($pdf); 448 check_missing(\%map); 315 check_missing(\%map); 449 316 450 return if (!$need && !$optional); 317 return if (!$need && !$optional); 451 318 452 if (!$old) { !! 319 if ($release >= 18) { 453 # dnf, for Fedora 18+ 320 # dnf, for Fedora 18+ 454 printf("You should run:\n") if !! 321 printf("You should run:\n\n\tsudo dnf install -y $install\n"); 455 printf("\n\tsudo dnf install - << 456 } else { 322 } else { 457 # yum, for RHEL (and clones) o 323 # yum, for RHEL (and clones) or Fedora version < 18 458 printf("You should run:\n") if !! 324 printf("You should run:\n\n\tsudo yum install -y $install\n"); 459 printf("\n\tsudo yum install - << 460 } 325 } 461 } 326 } 462 327 463 sub give_opensuse_hints() 328 sub give_opensuse_hints() 464 { 329 { 465 my %map = ( 330 my %map = ( 466 "python-sphinx" => "py 331 "python-sphinx" => "python3-sphinx", 467 "yaml" => "py !! 332 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme", 468 "virtualenv" => "py 333 "virtualenv" => "python3-virtualenv", 469 "dot" => "gr 334 "dot" => "graphviz", 470 "convert" => "Im 335 "convert" => "ImageMagick", 471 "Pod::Usage" => "pe 336 "Pod::Usage" => "perl-Pod-Usage", 472 "xelatex" => "te 337 "xelatex" => "texlive-xetex-bin", >> 338 "rsvg-convert" => "rsvg-view", 473 ); 339 ); 474 340 475 # On Tumbleweed, this package is also << 476 $map{"rsvg-convert"} = "rsvg-view" if << 477 << 478 my @suse_tex_pkgs = ( 341 my @suse_tex_pkgs = ( 479 "texlive-babel-english", 342 "texlive-babel-english", 480 "texlive-caption", 343 "texlive-caption", 481 "texlive-colortbl", 344 "texlive-colortbl", 482 "texlive-courier", 345 "texlive-courier", 483 "texlive-dvips", 346 "texlive-dvips", 484 "texlive-helvetic", 347 "texlive-helvetic", 485 "texlive-makeindex", 348 "texlive-makeindex", 486 "texlive-metafont", 349 "texlive-metafont", 487 "texlive-metapost", 350 "texlive-metapost", 488 "texlive-palatino", 351 "texlive-palatino", 489 "texlive-preview", 352 "texlive-preview", 490 "texlive-times", 353 "texlive-times", 491 "texlive-zapfchan", 354 "texlive-zapfchan", 492 "texlive-zapfding", 355 "texlive-zapfding", 493 ); 356 ); 494 357 495 $map{"latexmk"} = "texlive-latexmk-bin !! 358 check_rpm_missing(\@suse_tex_pkgs, 1) if ($pdf); 496 !! 359 check_missing_tex(1) if ($pdf); 497 # FIXME: add support for installing CJ << 498 # << 499 # I tried hard, but was unable to find << 500 # "Noto Sans CJK SC" on openSUSE << 501 << 502 check_rpm_missing(\@suse_tex_pkgs, 2) << 503 check_missing_tex(2) if ($pdf); << 504 check_missing(\%map); 360 check_missing(\%map); 505 361 506 return if (!$need && !$optional); 362 return if (!$need && !$optional); 507 printf("You should run:\n") if ($verbo !! 363 printf("You should run:\n\n\tsudo zypper install --no-recommends $install\n"); 508 printf("\n\tsudo zypper install --no-r << 509 } 364 } 510 365 511 sub give_mageia_hints() 366 sub give_mageia_hints() 512 { 367 { 513 my %map = ( 368 my %map = ( 514 "python-sphinx" => "py 369 "python-sphinx" => "python3-sphinx", 515 "yaml" => "py !! 370 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme", 516 "virtualenv" => "py 371 "virtualenv" => "python3-virtualenv", 517 "dot" => "gr 372 "dot" => "graphviz", 518 "convert" => "Im 373 "convert" => "ImageMagick", 519 "Pod::Usage" => "pe 374 "Pod::Usage" => "perl-Pod-Usage", 520 "xelatex" => "te 375 "xelatex" => "texlive", 521 "rsvg-convert" => "li !! 376 "rsvg-convert" => "librsvg2-tools", 522 ); 377 ); 523 378 524 my @tex_pkgs = ( 379 my @tex_pkgs = ( 525 "texlive-fontsextra", 380 "texlive-fontsextra", 526 ); 381 ); 527 382 528 $map{"latexmk"} = "texlive-collection- !! 383 check_rpm_missing(\@tex_pkgs, 1) if ($pdf); 529 << 530 my $packager_cmd; << 531 my $noto_sans; << 532 if ($system_release =~ /OpenMandriva/) << 533 $packager_cmd = "dnf install"; << 534 $noto_sans = "noto-sans-cjk-fo << 535 @tex_pkgs = ( "texlive-collect << 536 } else { << 537 $packager_cmd = "urpmi"; << 538 $noto_sans = "google-noto-sans << 539 } << 540 << 541 << 542 if ($pdf) { << 543 check_missing_file(["/usr/shar << 544 "/usr/shar << 545 $noto_sans, << 546 } << 547 << 548 check_rpm_missing(\@tex_pkgs, 2) if ($ << 549 check_missing(\%map); 384 check_missing(\%map); 550 385 551 return if (!$need && !$optional); 386 return if (!$need && !$optional); 552 printf("You should run:\n") if ($verbo !! 387 printf("You should run:\n\n\tsudo urpmi $install\n"); 553 printf("\n\tsudo $packager_cmd $instal << 554 } 388 } 555 389 556 sub give_arch_linux_hints() 390 sub give_arch_linux_hints() 557 { 391 { 558 my %map = ( 392 my %map = ( 559 "yaml" => "py !! 393 "sphinx_rtd_theme" => "python-sphinx_rtd_theme", 560 "virtualenv" => "py 394 "virtualenv" => "python-virtualenv", 561 "dot" => "gr 395 "dot" => "graphviz", 562 "convert" => "im 396 "convert" => "imagemagick", 563 "xelatex" => "te !! 397 "xelatex" => "texlive-bin", 564 "latexmk" => "te << 565 "rsvg-convert" => "ex 398 "rsvg-convert" => "extra/librsvg", 566 ); 399 ); 567 400 568 my @archlinux_tex_pkgs = ( 401 my @archlinux_tex_pkgs = ( 569 "texlive-core", 402 "texlive-core", 570 "texlive-latexextra", 403 "texlive-latexextra", 571 "ttf-dejavu", 404 "ttf-dejavu", 572 ); 405 ); 573 check_pacman_missing(\@archlinux_tex_p !! 406 check_pacman_missing(\@archlinux_tex_pkgs, 1) if ($pdf); 574 << 575 if ($pdf) { << 576 check_missing_file(["/usr/shar << 577 "noto-fonts << 578 } << 579 << 580 check_missing(\%map); 407 check_missing(\%map); 581 408 582 return if (!$need && !$optional); 409 return if (!$need && !$optional); 583 printf("You should run:\n") if ($verbo !! 410 printf("You should run:\n\n\tsudo pacman -S $install\n"); 584 printf("\n\tsudo pacman -S $install\n" << 585 } 411 } 586 412 587 sub give_gentoo_hints() 413 sub give_gentoo_hints() 588 { 414 { 589 my %map = ( 415 my %map = ( 590 "yaml" => "de !! 416 "sphinx_rtd_theme" => "dev-python/sphinx_rtd_theme", 591 "virtualenv" => "de 417 "virtualenv" => "dev-python/virtualenv", 592 "dot" => "me 418 "dot" => "media-gfx/graphviz", 593 "convert" => "me 419 "convert" => "media-gfx/imagemagick", 594 "xelatex" => "de 420 "xelatex" => "dev-texlive/texlive-xetex media-fonts/dejavu", 595 "rsvg-convert" => "gn 421 "rsvg-convert" => "gnome-base/librsvg", 596 ); 422 ); 597 423 598 check_missing_file(["/usr/share/fonts/ !! 424 check_missing_file("/usr/share/fonts/dejavu/DejaVuSans.ttf", 599 "media-fonts/dejavu !! 425 "media-fonts/dejavu", 1) if ($pdf); 600 << 601 if ($pdf) { << 602 check_missing_file(["/usr/shar << 603 "/usr/shar << 604 "media-font << 605 } << 606 426 607 check_missing(\%map); 427 check_missing(\%map); 608 428 609 return if (!$need && !$optional); 429 return if (!$need && !$optional); 610 430 611 printf("You should run:\n") if ($verbo !! 431 printf("You should run:\n\n"); 612 printf("\n"); !! 432 printf("\tsudo su -c 'echo \"media-gfx/imagemagick svg png\" > /etc/portage/package.use/imagemagick'\n"); 613 !! 433 printf("\tsudo su -c 'echo \"media-gfx/graphviz cairo pdf\" > /etc/portage/package.use/graphviz'\n"); 614 my $imagemagick = "media-gfx/imagemagi << 615 my $cairo = "media-gfx/graphviz cairo << 616 my $portage_imagemagick = "/etc/portag << 617 my $portage_cairo = "/etc/portage/pack << 618 << 619 if (qx(grep imagemagick $portage_image << 620 printf("\tsudo su -c 'echo \"$ << 621 } << 622 if (qx(grep graphviz $portage_cairo 2> << 623 printf("\tsudo su -c 'echo \"$ << 624 } << 625 << 626 printf("\tsudo emerge --ask $install\n 434 printf("\tsudo emerge --ask $install\n"); 627 435 628 } 436 } 629 437 630 sub check_distros() 438 sub check_distros() 631 { 439 { 632 # Distro-specific hints 440 # Distro-specific hints 633 if ($system_release =~ /Red Hat Enterp 441 if ($system_release =~ /Red Hat Enterprise Linux/) { 634 give_redhat_hints; 442 give_redhat_hints; 635 return; 443 return; 636 } 444 } 637 if ($system_release =~ /CentOS/) { 445 if ($system_release =~ /CentOS/) { 638 give_redhat_hints; 446 give_redhat_hints; 639 return; 447 return; 640 } 448 } 641 if ($system_release =~ /Scientific Lin 449 if ($system_release =~ /Scientific Linux/) { 642 give_redhat_hints; 450 give_redhat_hints; 643 return; 451 return; 644 } 452 } 645 if ($system_release =~ /Oracle Linux S 453 if ($system_release =~ /Oracle Linux Server/) { 646 give_redhat_hints; 454 give_redhat_hints; 647 return; 455 return; 648 } 456 } 649 if ($system_release =~ /Fedora/) { 457 if ($system_release =~ /Fedora/) { 650 give_redhat_hints; 458 give_redhat_hints; 651 return; 459 return; 652 } 460 } 653 if ($system_release =~ /Ubuntu/) { 461 if ($system_release =~ /Ubuntu/) { 654 give_debian_hints; 462 give_debian_hints; 655 return; 463 return; 656 } 464 } 657 if ($system_release =~ /Debian/) { 465 if ($system_release =~ /Debian/) { 658 give_debian_hints; 466 give_debian_hints; 659 return; 467 return; 660 } 468 } 661 if ($system_release =~ /openSUSE/) { 469 if ($system_release =~ /openSUSE/) { 662 give_opensuse_hints; 470 give_opensuse_hints; 663 return; 471 return; 664 } 472 } 665 if ($system_release =~ /Mageia/) { 473 if ($system_release =~ /Mageia/) { 666 give_mageia_hints; 474 give_mageia_hints; 667 return; 475 return; 668 } 476 } 669 if ($system_release =~ /OpenMandriva/) << 670 give_mageia_hints; << 671 return; << 672 } << 673 if ($system_release =~ /Arch Linux/) { 477 if ($system_release =~ /Arch Linux/) { 674 give_arch_linux_hints; 478 give_arch_linux_hints; 675 return; 479 return; 676 } 480 } 677 if ($system_release =~ /Gentoo/) { 481 if ($system_release =~ /Gentoo/) { 678 give_gentoo_hints; 482 give_gentoo_hints; 679 return; 483 return; 680 } 484 } 681 485 682 # 486 # 683 # Fall-back to generic hint code for o 487 # Fall-back to generic hint code for other distros 684 # That's far from ideal, specially for 488 # That's far from ideal, specially for LaTeX dependencies. 685 # 489 # 686 my %map = ( 490 my %map = ( 687 "sphinx-build" => "sphinx" 491 "sphinx-build" => "sphinx" 688 ); 492 ); 689 check_missing_tex(2) if ($pdf); !! 493 check_missing_tex(1) if ($pdf); 690 check_missing(\%map); 494 check_missing(\%map); 691 print "I don't know distro $system_rel 495 print "I don't know distro $system_release.\n"; 692 print "So, I can't provide you a hint 496 print "So, I can't provide you a hint with the install procedure.\n"; 693 print "There are likely missing depend 497 print "There are likely missing dependencies.\n"; 694 } 498 } 695 499 696 # 500 # 697 # Common dependencies 501 # Common dependencies 698 # 502 # 699 503 700 sub deactivate_help() << 701 { << 702 printf "\n If you want to exit the << 703 printf "\tdeactivate\n"; << 704 } << 705 << 706 sub get_virtenv() << 707 { << 708 my $ver; << 709 my $min_activate = "$ENV{'PWD'}/${virt << 710 my @activates = glob "$ENV{'PWD'}/${vi << 711 << 712 @activates = sort {$b cmp $a} @activat << 713 << 714 foreach my $f (@activates) { << 715 next if ($f lt $min_activate); << 716 << 717 my $sphinx_cmd = $f; << 718 $sphinx_cmd =~ s/activate/sphi << 719 next if (! -f $sphinx_cmd); << 720 << 721 my $ver = get_sphinx_version($ << 722 << 723 if (!$ver) { << 724 $f =~ s#/bin/activate# << 725 print("Warning: virtua << 726 } << 727 << 728 if ($need_sphinx && ($ver ge $ << 729 return ($f, $ver); << 730 } elsif ($ver gt $cur_version) << 731 return ($f, $ver); << 732 } << 733 } << 734 return ("", ""); << 735 } << 736 << 737 sub recommend_sphinx_upgrade() << 738 { << 739 my $venv_ver; << 740 << 741 # Avoid running sphinx-builds from ven << 742 if ($cur_version && ($cur_version ge $ << 743 $latest_avail_ver = $cur_versi << 744 return; << 745 } << 746 << 747 # Get the highest version from sphinx_ << 748 # corresponding command to activate th << 749 ($activate_cmd, $venv_ver) = get_virte << 750 << 751 # Store the highest version from Sphin << 752 if (($activate_cmd ne "") && ($venv_ve << 753 $latest_avail_ver = $venv_ver; << 754 } else { << 755 $latest_avail_ver = $cur_versi << 756 } << 757 << 758 # As we don't know package version of << 759 # virtual environments, don't check if << 760 if (!$virtualenv) { << 761 return if (!$latest_avail_ver) << 762 } << 763 << 764 # Either there are already a virtual e << 765 $need_pip = 1; << 766 << 767 return if (!$latest_avail_ver); << 768 << 769 # Return if the reason is due to an up << 770 if ($latest_avail_ver lt $rec_version) << 771 $rec_sphinx_upgrade = 1; << 772 } << 773 << 774 return $latest_avail_ver; << 775 } << 776 << 777 # << 778 # The logic here is complex, as it have to dea << 779 # - minimal supported version; << 780 # - minimal PDF version; << 781 # - recommended version. << 782 # It also needs to work fine with both distro' << 783 sub recommend_sphinx_version($) << 784 { << 785 my $virtualenv_cmd = shift; << 786 << 787 # Version is OK. Nothing to do. << 788 if ($cur_version && ($cur_version ge $ << 789 return; << 790 }; << 791 << 792 if (!$need_sphinx) { << 793 # sphinx-build is present and << 794 << 795 #only recommend enabling a new << 796 if ($latest_avail_ver gt $cur_ << 797 printf "\nYou may also << 798 printf "\tdeactivate\n << 799 printf "\t. $activate_ << 800 deactivate_help(); << 801 << 802 return; << 803 } << 804 return if ($latest_avail_ver g << 805 } << 806 << 807 if (!$virtualenv) { << 808 # No sphinx either via package << 809 # Compare the versions here, j << 810 # user to install it from the << 811 return if (!$latest_avail_ver) << 812 << 813 # User doesn't want a virtenv << 814 # installed one via virtenv wi << 815 # So, print commands to enable << 816 if ($latest_avail_ver gt $cur_ << 817 printf "\nYou may also << 818 printf "\tdeactivate\n << 819 printf "\t. $activate_ << 820 deactivate_help(); << 821 << 822 return; << 823 } << 824 print "\n"; << 825 } else { << 826 $need++ if ($need_sphinx); << 827 } << 828 << 829 # Suggest newer versions if current on << 830 if ($latest_avail_ver && $latest_avail << 831 # If there's a good enough ver << 832 if ($latest_avail_ver ge $rec_ << 833 printf "\nNeed to acti << 834 printf "\t. $activate_ << 835 deactivate_help(); << 836 << 837 return; << 838 } << 839 << 840 # Version is above the minimal << 841 # below the recommended one. S << 842 << 843 if ($latest_avail_ver lt $rec_ << 844 print "Warning: It is << 845 } << 846 } << 847 << 848 # At this point, either it needs Sphin << 849 # both via pip << 850 << 851 if ($rec_sphinx_upgrade) { << 852 if (!$virtualenv) { << 853 print "Instead of inst << 854 } else { << 855 print "To upgrade Sphi << 856 } << 857 } else { << 858 print "\nSphinx needs to be in << 859 } << 860 << 861 $python_cmd = find_python_no_venv(); << 862 << 863 printf "\t$virtualenv_cmd $virtenv_dir << 864 << 865 printf "\t. $virtenv_dir/bin/activate\ << 866 printf "\tpip install -r $requirement_ << 867 deactivate_help(); << 868 << 869 printf "\n2) As a package with:\n"; << 870 << 871 my $old_need = $need; << 872 my $old_optional = $optional; << 873 %missing = (); << 874 $pdf = 0; << 875 $optional = 0; << 876 $install = ""; << 877 $verbose_warn_install = 0; << 878 << 879 add_package("python-sphinx", 0); << 880 << 881 check_distros(); << 882 << 883 $need = $old_need; << 884 $optional = $old_optional; << 885 << 886 printf "\n Please note that Sphinx << 887 printf " warning when the same name << 888 printf " structs, enums,...). This i << 889 printf "\thttps://github.com/sphinx-do << 890 } << 891 << 892 sub check_needs() 504 sub check_needs() 893 { 505 { 894 # Check if Sphinx is already accessibl << 895 check_sphinx(); << 896 << 897 if ($system_release) { 506 if ($system_release) { 898 print "Detected OS: $system_re 507 print "Detected OS: $system_release.\n"; 899 } else { 508 } else { 900 print "Unknown OS\n"; 509 print "Unknown OS\n"; 901 } 510 } 902 printf "Sphinx version: %s\n\n", $cur_ << 903 << 904 # Check python command line, trying fi << 905 $python_cmd = findprog("python3"); << 906 $python_cmd = check_program("python", << 907 << 908 # Check the type of virtual env, depen << 909 if ($python_cmd) { << 910 if ($virtualenv) { << 911 my $tmp = qx($python_c << 912 if ($tmp =~ m/(\d+\.)( << 913 if ($1 < 3) { << 914 # Fail << 915 die "P << 916 } << 917 if ($1 == 3 && << 918 # Need << 919 $need_ << 920 } << 921 } else { << 922 die "Warning: << 923 } << 924 } else { << 925 add_package("python-sp << 926 } << 927 } << 928 511 929 my $venv_ver = recommend_sphinx_upgrad !! 512 # RHEL 7.x and clones have Sphinx version 1.1.x and incomplete texlive 930 !! 513 if (($system_release =~ /Red Hat Enterprise Linux/) || 931 my $virtualenv_cmd; !! 514 ($system_release =~ /CentOS/) || >> 515 ($system_release =~ /Scientific Linux/) || >> 516 ($system_release =~ /Oracle Linux Server/)) { >> 517 $virtualenv = 1; >> 518 $pdf = 0; 932 519 933 if ($need_pip) { !! 520 printf("NOTE: On this distro, Sphinx and TexLive shipped versions are incompatible\n"); 934 # Set virtualenv command line, !! 521 printf("with doc build. So, use Sphinx via a Python virtual environment.\n\n"); 935 if ($need_virtualenv) { !! 522 printf("This script can't install a TexLive version that would provide PDF.\n"); 936 $virtualenv_cmd = find << 937 $virtualenv_cmd = find << 938 if (!$virtualenv_cmd) << 939 check_program( << 940 $virtualenv_cm << 941 } << 942 } else { << 943 $virtualenv_cmd = "$py << 944 check_python_module("e << 945 } << 946 } 523 } 947 524 948 # Check for needed programs/tools 525 # Check for needed programs/tools >> 526 check_sphinx(); 949 check_perl_module("Pod::Usage", 0); 527 check_perl_module("Pod::Usage", 0); 950 check_python_module("yaml", 0); << 951 check_program("make", 0); 528 check_program("make", 0); 952 check_program("gcc", 0); 529 check_program("gcc", 0); >> 530 check_python_module("sphinx_rtd_theme", 1) if (!$virtualenv); >> 531 check_program("xelatex", 1) if ($pdf); 953 check_program("dot", 1); 532 check_program("dot", 1); 954 check_program("convert", 1); 533 check_program("convert", 1); >> 534 check_program("rsvg-convert", 1) if ($pdf); 955 535 956 # Extra PDF files - should use 2 for i << 957 check_program("xelatex", 2) if ($pdf); << 958 check_program("rsvg-convert", 2) if ($ << 959 check_program("latexmk", 2) if ($pdf); << 960 << 961 # Do distro-specific checks and output << 962 check_distros(); 536 check_distros(); 963 537 964 if (!$python_cmd) { << 965 if ($need == 1) { << 966 die "Can't build as $n << 967 } elsif ($need) { << 968 die "Can't build as $n << 969 } << 970 } << 971 << 972 # Check if sphinx-build is called sphi << 973 if ($need_symlink) { 538 if ($need_symlink) { 974 printf "\tsudo ln -sf %s /usr/ 539 printf "\tsudo ln -sf %s /usr/bin/sphinx-build\n\n", 975 which("sphinx-build-3") 540 which("sphinx-build-3"); 976 } 541 } 977 !! 542 if ($need_sphinx) { 978 recommend_sphinx_version($virtualenv_c !! 543 my $activate = "$virtenv_dir/bin/activate"; >> 544 if (-e "$ENV{'PWD'}/$activate") { >> 545 printf "\nNeed to activate virtualenv with:\n"; >> 546 printf "\t. $activate\n"; >> 547 } else { >> 548 my $virtualenv = findprog("virtualenv-3"); >> 549 $virtualenv = findprog("virtualenv-3.5") if (!$virtualenv); >> 550 $virtualenv = findprog("virtualenv") if (!$virtualenv); >> 551 $virtualenv = "virtualenv" if (!$virtualenv); >> 552 >> 553 printf "\t$virtualenv $virtenv_dir\n"; >> 554 printf "\t. $activate\n"; >> 555 printf "\tpip install -r $requirement_file\n"; >> 556 $need++; >> 557 } >> 558 } 979 printf "\n"; 559 printf "\n"; 980 560 981 print "All optional dependencies are m !! 561 print "All optional dependenties are met.\n" if (!$optional); 982 562 983 if ($need == 1) { 563 if ($need == 1) { 984 die "Can't build as $need mand 564 die "Can't build as $need mandatory dependency is missing"; 985 } elsif ($need) { 565 } elsif ($need) { 986 die "Can't build as $need mand 566 die "Can't build as $need mandatory dependencies are missing"; 987 } 567 } 988 568 989 print "Needed package dependencies are 569 print "Needed package dependencies are met.\n"; 990 } 570 } 991 571 992 # 572 # 993 # Main 573 # Main 994 # 574 # 995 575 996 while (@ARGV) { 576 while (@ARGV) { 997 my $arg = shift(@ARGV); 577 my $arg = shift(@ARGV); 998 578 999 if ($arg eq "--no-virtualenv") { 579 if ($arg eq "--no-virtualenv") { 1000 $virtualenv = 0; 580 $virtualenv = 0; 1001 } elsif ($arg eq "--no-pdf"){ 581 } elsif ($arg eq "--no-pdf"){ 1002 $pdf = 0; 582 $pdf = 0; 1003 } elsif ($arg eq "--version-check"){ << 1004 $version_check = 1; << 1005 } else { 583 } else { 1006 print "Usage:\n\t$0 <--no-vir !! 584 print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf>\n\n"; 1007 print "Where:\n"; << 1008 print "\t--no-virtualenv\t- R << 1009 print "\t--version-check\t- i << 1010 print "\t--no-pdf\t- don't ch << 1011 exit -1; 585 exit -1; 1012 } 586 } 1013 } 587 } 1014 588 1015 # 589 # 1016 # Determine the system type. There's no stand 590 # Determine the system type. There's no standard unique way that would 1017 # work with all distros with a minimal packag 591 # work with all distros with a minimal package install. So, several 1018 # methods are used here. 592 # methods are used here. 1019 # 593 # 1020 # By default, it will use lsb_release functio 594 # By default, it will use lsb_release function. If not available, it will 1021 # fail back to reading the known different pl 595 # fail back to reading the known different places where the distro name 1022 # is stored 596 # is stored 1023 # 597 # 1024 598 1025 $system_release = qx(lsb_release -d) if which 599 $system_release = qx(lsb_release -d) if which("lsb_release"); 1026 $system_release =~ s/Description:\s*// if ($s 600 $system_release =~ s/Description:\s*// if ($system_release); 1027 $system_release = catcheck("/etc/system-relea 601 $system_release = catcheck("/etc/system-release") if !$system_release; 1028 $system_release = catcheck("/etc/redhat-relea 602 $system_release = catcheck("/etc/redhat-release") if !$system_release; 1029 $system_release = catcheck("/etc/lsb-release" 603 $system_release = catcheck("/etc/lsb-release") if !$system_release; 1030 $system_release = catcheck("/etc/gentoo-relea 604 $system_release = catcheck("/etc/gentoo-release") if !$system_release; 1031 << 1032 # This seems more common than LSB these days << 1033 if (!$system_release) { << 1034 my %os_var; << 1035 if (open IN, "cat /etc/os-release|") << 1036 while (<IN>) { << 1037 if (m/^([\w\d\_]+)=\" << 1038 $os_var{$1}=$ << 1039 } << 1040 } << 1041 $system_release = $os_var{"NA << 1042 if (defined($os_var{"VERSION_ << 1043 $system_release .= " << 1044 } else { << 1045 $system_release .= " << 1046 } << 1047 } << 1048 } << 1049 $system_release = catcheck("/etc/issue") if ! 605 $system_release = catcheck("/etc/issue") if !$system_release; 1050 $system_release =~ s/\s+$//; 606 $system_release =~ s/\s+$//; 1051 607 1052 check_needs; 608 check_needs;
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.