Commit | Line | Data |
---|---|---|
24071ac1 | 1 | #!/usr/bin/perl |
c942fddf | 2 | # SPDX-License-Identifier: GPL-2.0-or-later |
24071ac1 MCC |
3 | use strict; |
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 = ""; |
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 | { | |
ff8fdb36 | 127 | my $files = shift; |
24071ac1 MCC |
128 | my $package = shift; |
129 | my $is_optional = shift; | |
130 | ||
ff8fdb36 JM |
131 | for (@$files) { |
132 | return if(-e $_); | |
133 | } | |
24071ac1 MCC |
134 | |
135 | add_package($package, $is_optional); | |
136 | } | |
137 | ||
138 | sub findprog($) | |
139 | { | |
140 | foreach(split(/:/, $ENV{PATH})) { | |
141 | return "$_/$_[0]" if(-x "$_/$_[0]"); | |
142 | } | |
143 | } | |
144 | ||
145 | sub check_program($$) | |
146 | { | |
147 | my $prog = shift; | |
148 | my $is_optional = shift; | |
149 | ||
150 | return if findprog($prog); | |
151 | ||
152 | add_package($prog, $is_optional); | |
153 | } | |
154 | ||
155 | sub check_perl_module($$) | |
156 | { | |
157 | my $prog = shift; | |
158 | my $is_optional = shift; | |
159 | ||
160 | my $err = system("perl -M$prog -e 1 2>/dev/null /dev/null"); | |
161 | return if ($err == 0); | |
162 | ||
163 | add_package($prog, $is_optional); | |
164 | } | |
165 | ||
166 | sub check_python_module($$) | |
167 | { | |
168 | my $prog = shift; | |
169 | my $is_optional = shift; | |
170 | ||
171 | my $err = system("python3 -c 'import $prog' 2>/dev/null /dev/null"); | |
172 | return if ($err == 0); | |
173 | my $err = system("python -c 'import $prog' 2>/dev/null /dev/null"); | |
174 | return if ($err == 0); | |
175 | ||
176 | add_package($prog, $is_optional); | |
177 | } | |
178 | ||
179 | sub check_rpm_missing($$) | |
180 | { | |
181 | my @pkgs = @{$_[0]}; | |
182 | my $is_optional = $_[1]; | |
183 | ||
184 | foreach my $prog(@pkgs) { | |
185 | my $err = system("rpm -q '$prog' 2>/dev/null >/dev/null"); | |
186 | add_package($prog, $is_optional) if ($err); | |
187 | } | |
188 | } | |
189 | ||
190 | sub check_pacman_missing($$) | |
191 | { | |
192 | my @pkgs = @{$_[0]}; | |
193 | my $is_optional = $_[1]; | |
194 | ||
195 | foreach my $prog(@pkgs) { | |
196 | my $err = system("pacman -Q '$prog' 2>/dev/null >/dev/null"); | |
197 | add_package($prog, $is_optional) if ($err); | |
198 | } | |
199 | } | |
200 | ||
201 | sub check_missing_tex($) | |
202 | { | |
203 | my $is_optional = shift; | |
204 | my $kpsewhich = findprog("kpsewhich"); | |
205 | ||
206 | foreach my $prog(keys %texlive) { | |
207 | my $package = $texlive{$prog}; | |
208 | if (!$kpsewhich) { | |
209 | add_package($package, $is_optional); | |
210 | next; | |
211 | } | |
212 | my $file = qx($kpsewhich $prog); | |
213 | add_package($package, $is_optional) if ($file =~ /^\s*$/); | |
214 | } | |
215 | } | |
216 | ||
77d09ad9 | 217 | sub get_sphinx_fname() |
24071ac1 | 218 | { |
77d09ad9 MCC |
219 | my $fname = "sphinx-build"; |
220 | return $fname if findprog($fname); | |
24071ac1 | 221 | |
77d09ad9 MCC |
222 | $fname = "sphinx-build-3"; |
223 | if (findprog($fname)) { | |
24071ac1 | 224 | $need_symlink = 1; |
77d09ad9 | 225 | return $fname; |
24071ac1 MCC |
226 | } |
227 | ||
228 | if ($virtualenv) { | |
800d408a MCC |
229 | my $prog = findprog("virtualenv-3"); |
230 | $prog = findprog("virtualenv-3.5") if (!$prog); | |
231 | ||
232 | check_program("virtualenv", 0) if (!$prog); | |
24071ac1 MCC |
233 | $need_sphinx = 1; |
234 | } else { | |
235 | add_package("python-sphinx", 0); | |
236 | } | |
77d09ad9 MCC |
237 | |
238 | return ""; | |
239 | } | |
240 | ||
241 | sub check_sphinx() | |
242 | { | |
77d09ad9 MCC |
243 | my $rec_version; |
244 | my $cur_version; | |
245 | ||
246 | open IN, $conf or die "Can't open $conf"; | |
247 | while (<IN>) { | |
248 | if (m/^\s*needs_sphinx\s*=\s*[\'\"]([\d\.]+)[\'\"]/) { | |
249 | $min_version=$1; | |
250 | last; | |
251 | } | |
252 | } | |
253 | close IN; | |
254 | ||
255 | die "Can't get needs_sphinx version from $conf" if (!$min_version); | |
256 | ||
257 | open IN, $requirement_file or die "Can't open $requirement_file"; | |
258 | while (<IN>) { | |
259 | if (m/^\s*Sphinx\s*==\s*([\d\.]+)$/) { | |
260 | $rec_version=$1; | |
261 | last; | |
262 | } | |
263 | } | |
264 | close IN; | |
265 | ||
266 | die "Can't get recommended sphinx version from $requirement_file" if (!$min_version); | |
267 | ||
44f42165 | 268 | $virtenv_dir = $virtenv_prefix . $rec_version; |
77d09ad9 MCC |
269 | |
270 | my $sphinx = get_sphinx_fname(); | |
271 | return if ($sphinx eq ""); | |
272 | ||
273 | open IN, "$sphinx --version 2>&1 |" or die "$sphinx returned an error"; | |
274 | while (<IN>) { | |
d1c9038a | 275 | if (m/^\s*sphinx-build\s+([\d\.]+)(\+\/[\da-f]+)?$/) { |
77d09ad9 MCC |
276 | $cur_version=$1; |
277 | last; | |
278 | } | |
279 | # Sphinx 1.2.x uses a different format | |
280 | if (m/^\s*Sphinx.*\s+([\d\.]+)$/) { | |
281 | $cur_version=$1; | |
282 | last; | |
283 | } | |
284 | } | |
285 | close IN; | |
286 | ||
287 | die "$sphinx didn't return its version" if (!$cur_version); | |
288 | ||
77d09ad9 | 289 | if ($cur_version lt $min_version) { |
9b88ad54 MCC |
290 | printf "ERROR: Sphinx version is %s. It should be >= %s (recommended >= %s)\n", |
291 | $cur_version, $min_version, $rec_version;; | |
77d09ad9 MCC |
292 | $need_sphinx = 1; |
293 | return; | |
294 | } | |
295 | ||
296 | if ($cur_version lt $rec_version) { | |
9b88ad54 | 297 | printf "Sphinx version %s\n", $cur_version; |
77d09ad9 | 298 | print "Warning: It is recommended at least Sphinx version $rec_version.\n"; |
77d09ad9 | 299 | $rec_sphinx_upgrade = 1; |
9b88ad54 | 300 | return; |
77d09ad9 | 301 | } |
9b88ad54 MCC |
302 | |
303 | # On version check mode, just assume Sphinx has all mandatory deps | |
304 | exit (0) if ($version_check); | |
24071ac1 MCC |
305 | } |
306 | ||
307 | # | |
308 | # Ancillary subroutines | |
309 | # | |
310 | ||
311 | sub catcheck($) | |
312 | { | |
313 | my $res = ""; | |
314 | $res = qx(cat $_[0]) if (-r $_[0]); | |
315 | return $res; | |
316 | } | |
317 | ||
318 | sub which($) | |
319 | { | |
320 | my $file = shift; | |
321 | my @path = split ":", $ENV{PATH}; | |
322 | ||
323 | foreach my $dir(@path) { | |
324 | my $name = $dir.'/'.$file; | |
325 | return $name if (-x $name ); | |
326 | } | |
327 | return undef; | |
328 | } | |
329 | ||
330 | # | |
331 | # Subroutines that check distro-specific hints | |
332 | # | |
333 | ||
334 | sub give_debian_hints() | |
335 | { | |
336 | my %map = ( | |
337 | "python-sphinx" => "python3-sphinx", | |
338 | "sphinx_rtd_theme" => "python3-sphinx-rtd-theme", | |
339 | "virtualenv" => "virtualenv", | |
24071ac1 MCC |
340 | "dot" => "graphviz", |
341 | "convert" => "imagemagick", | |
342 | "Pod::Usage" => "perl-modules", | |
343 | "xelatex" => "texlive-xetex", | |
8e7d5d15 | 344 | "rsvg-convert" => "librsvg2-bin", |
24071ac1 MCC |
345 | ); |
346 | ||
347 | if ($pdf) { | |
ff8fdb36 | 348 | check_missing_file(["/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf"], |
56e5a633 | 349 | "fonts-dejavu", 2); |
27eed923 | 350 | |
9692f2fd | 351 | check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc", |
bfc7f428 MCC |
352 | "/usr/share/fonts/opentype/noto/NotoSansCJK-Regular.ttc", |
353 | "/usr/share/fonts/opentype/noto/NotoSerifCJK-Regular.ttc"], | |
27eed923 | 354 | "fonts-noto-cjk", 2); |
24071ac1 MCC |
355 | } |
356 | ||
56e5a633 | 357 | check_program("dvipng", 2) if ($pdf); |
24071ac1 MCC |
358 | check_missing(\%map); |
359 | ||
360 | return if (!$need && !$optional); | |
361 | printf("You should run:\n\n\tsudo apt-get install $install\n"); | |
362 | } | |
363 | ||
364 | sub give_redhat_hints() | |
365 | { | |
366 | my %map = ( | |
367 | "python-sphinx" => "python3-sphinx", | |
368 | "sphinx_rtd_theme" => "python3-sphinx_rtd_theme", | |
369 | "virtualenv" => "python3-virtualenv", | |
24071ac1 MCC |
370 | "dot" => "graphviz", |
371 | "convert" => "ImageMagick", | |
372 | "Pod::Usage" => "perl-Pod-Usage", | |
373 | "xelatex" => "texlive-xetex-bin", | |
8e7d5d15 | 374 | "rsvg-convert" => "librsvg2-tools", |
24071ac1 MCC |
375 | ); |
376 | ||
5d88953c MCC |
377 | my @fedora26_opt_pkgs = ( |
378 | "graphviz-gd", # Fedora 26: needed for PDF support | |
379 | ); | |
380 | ||
24071ac1 MCC |
381 | my @fedora_tex_pkgs = ( |
382 | "texlive-collection-fontsrecommended", | |
383 | "texlive-collection-latex", | |
27eed923 | 384 | "texlive-xecjk", |
24071ac1 MCC |
385 | "dejavu-sans-fonts", |
386 | "dejavu-serif-fonts", | |
387 | "dejavu-sans-mono-fonts", | |
388 | ); | |
389 | ||
9b756a9d MCC |
390 | # |
391 | # Checks valid for RHEL/CentOS version 7.x. | |
392 | # | |
56e5a633 MCC |
393 | my $old = 0; |
394 | my $rel; | |
395 | $rel = $1 if ($system_release =~ /release\s+(\d+)/); | |
396 | ||
b308467c | 397 | if (!($system_release =~ /Fedora/)) { |
9b756a9d | 398 | $map{"virtualenv"} = "python-virtualenv"; |
9b756a9d | 399 | |
56e5a633 MCC |
400 | if ($rel && $rel < 8) { |
401 | $old = 1; | |
402 | $pdf = 0; | |
5d88953c | 403 | |
56e5a633 MCC |
404 | printf("Note: texlive packages on RHEL/CENTOS <= 7 are incomplete. Can't support PDF output\n"); |
405 | printf("If you want to build PDF, please read:\n"); | |
406 | printf("\thttps://www.systutorials.com/241660/how-to-install-tex-live-on-centos-7-linux/\n"); | |
407 | } | |
408 | } else { | |
409 | if ($rel && $rel < 26) { | |
410 | $old = 1; | |
411 | } | |
412 | } | |
413 | if (!$rel) { | |
414 | printf("Couldn't identify release number\n"); | |
415 | $old = 1; | |
416 | $pdf = 0; | |
417 | } | |
5d88953c | 418 | |
27eed923 | 419 | if ($pdf) { |
ff8fdb36 | 420 | check_missing_file(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc"], |
27eed923 MCC |
421 | "google-noto-sans-cjk-ttc-fonts", 2); |
422 | } | |
423 | ||
56e5a633 MCC |
424 | check_rpm_missing(\@fedora26_opt_pkgs, 2) if ($pdf && !$old); |
425 | check_rpm_missing(\@fedora_tex_pkgs, 2) if ($pdf); | |
426 | check_missing_tex(2) if ($pdf); | |
24071ac1 MCC |
427 | check_missing(\%map); |
428 | ||
429 | return if (!$need && !$optional); | |
9b756a9d | 430 | |
56e5a633 | 431 | if (!$old) { |
9b756a9d MCC |
432 | # dnf, for Fedora 18+ |
433 | printf("You should run:\n\n\tsudo dnf install -y $install\n"); | |
434 | } else { | |
435 | # yum, for RHEL (and clones) or Fedora version < 18 | |
436 | printf("You should run:\n\n\tsudo yum install -y $install\n"); | |
437 | } | |
24071ac1 MCC |
438 | } |
439 | ||
440 | sub give_opensuse_hints() | |
441 | { | |
442 | my %map = ( | |
443 | "python-sphinx" => "python3-sphinx", | |
444 | "sphinx_rtd_theme" => "python3-sphinx_rtd_theme", | |
445 | "virtualenv" => "python3-virtualenv", | |
24071ac1 MCC |
446 | "dot" => "graphviz", |
447 | "convert" => "ImageMagick", | |
448 | "Pod::Usage" => "perl-Pod-Usage", | |
449 | "xelatex" => "texlive-xetex-bin", | |
450 | ); | |
451 | ||
b3df6223 MCC |
452 | # On Tumbleweed, this package is also named rsvg-convert |
453 | $map{"rsvg-convert"} = "rsvg-view" if (!($system_release =~ /Tumbleweed/)); | |
454 | ||
24071ac1 MCC |
455 | my @suse_tex_pkgs = ( |
456 | "texlive-babel-english", | |
457 | "texlive-caption", | |
458 | "texlive-colortbl", | |
459 | "texlive-courier", | |
460 | "texlive-dvips", | |
461 | "texlive-helvetic", | |
462 | "texlive-makeindex", | |
463 | "texlive-metafont", | |
464 | "texlive-metapost", | |
465 | "texlive-palatino", | |
466 | "texlive-preview", | |
467 | "texlive-times", | |
468 | "texlive-zapfchan", | |
469 | "texlive-zapfding", | |
470 | ); | |
471 | ||
353290a9 MCC |
472 | $map{"latexmk"} = "texlive-latexmk-bin"; |
473 | ||
27eed923 MCC |
474 | # FIXME: add support for installing CJK fonts |
475 | # | |
476 | # I tried hard, but was unable to find a way to install | |
477 | # "Noto Sans CJK SC" on openSUSE | |
478 | ||
56e5a633 MCC |
479 | check_rpm_missing(\@suse_tex_pkgs, 2) if ($pdf); |
480 | check_missing_tex(2) if ($pdf); | |
24071ac1 MCC |
481 | check_missing(\%map); |
482 | ||
483 | return if (!$need && !$optional); | |
484 | printf("You should run:\n\n\tsudo zypper install --no-recommends $install\n"); | |
485 | } | |
486 | ||
800d408a MCC |
487 | sub give_mageia_hints() |
488 | { | |
489 | my %map = ( | |
490 | "python-sphinx" => "python3-sphinx", | |
491 | "sphinx_rtd_theme" => "python3-sphinx_rtd_theme", | |
492 | "virtualenv" => "python3-virtualenv", | |
800d408a MCC |
493 | "dot" => "graphviz", |
494 | "convert" => "ImageMagick", | |
495 | "Pod::Usage" => "perl-Pod-Usage", | |
496 | "xelatex" => "texlive", | |
497 | "rsvg-convert" => "librsvg2-tools", | |
498 | ); | |
499 | ||
500 | my @tex_pkgs = ( | |
501 | "texlive-fontsextra", | |
502 | ); | |
503 | ||
353290a9 MCC |
504 | $map{"latexmk"} = "texlive-collection-basic"; |
505 | ||
27eed923 | 506 | if ($pdf) { |
ff8fdb36 | 507 | check_missing_file(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc"], |
27eed923 MCC |
508 | "google-noto-sans-cjk-ttc-fonts", 2); |
509 | } | |
510 | ||
56e5a633 | 511 | check_rpm_missing(\@tex_pkgs, 2) if ($pdf); |
800d408a MCC |
512 | check_missing(\%map); |
513 | ||
514 | return if (!$need && !$optional); | |
515 | printf("You should run:\n\n\tsudo urpmi $install\n"); | |
516 | } | |
517 | ||
24071ac1 MCC |
518 | sub give_arch_linux_hints() |
519 | { | |
520 | my %map = ( | |
521 | "sphinx_rtd_theme" => "python-sphinx_rtd_theme", | |
522 | "virtualenv" => "python-virtualenv", | |
24071ac1 MCC |
523 | "dot" => "graphviz", |
524 | "convert" => "imagemagick", | |
525 | "xelatex" => "texlive-bin", | |
0d0da9aa | 526 | "latexmk" => "texlive-core", |
8e7d5d15 | 527 | "rsvg-convert" => "extra/librsvg", |
24071ac1 MCC |
528 | ); |
529 | ||
530 | my @archlinux_tex_pkgs = ( | |
531 | "texlive-core", | |
532 | "texlive-latexextra", | |
533 | "ttf-dejavu", | |
534 | ); | |
56e5a633 MCC |
535 | check_pacman_missing(\@archlinux_tex_pkgs, 2) if ($pdf); |
536 | ||
27eed923 | 537 | if ($pdf) { |
ff8fdb36 | 538 | check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc"], |
27eed923 MCC |
539 | "noto-fonts-cjk", 2); |
540 | } | |
541 | ||
24071ac1 MCC |
542 | check_missing(\%map); |
543 | ||
544 | return if (!$need && !$optional); | |
545 | printf("You should run:\n\n\tsudo pacman -S $install\n"); | |
546 | } | |
547 | ||
548 | sub give_gentoo_hints() | |
549 | { | |
550 | my %map = ( | |
551 | "sphinx_rtd_theme" => "dev-python/sphinx_rtd_theme", | |
552 | "virtualenv" => "dev-python/virtualenv", | |
24071ac1 MCC |
553 | "dot" => "media-gfx/graphviz", |
554 | "convert" => "media-gfx/imagemagick", | |
555 | "xelatex" => "dev-texlive/texlive-xetex media-fonts/dejavu", | |
8e7d5d15 | 556 | "rsvg-convert" => "gnome-base/librsvg", |
24071ac1 MCC |
557 | ); |
558 | ||
ff8fdb36 | 559 | check_missing_file(["/usr/share/fonts/dejavu/DejaVuSans.ttf"], |
56e5a633 | 560 | "media-fonts/dejavu", 2) if ($pdf); |
24071ac1 | 561 | |
27eed923 | 562 | if ($pdf) { |
e45a6317 MCC |
563 | check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJKsc-Regular.otf", |
564 | "/usr/share/fonts/noto-cjk/NotoSerifCJK-Regular.ttc"], | |
27eed923 MCC |
565 | "media-fonts/noto-cjk", 2); |
566 | } | |
567 | ||
24071ac1 MCC |
568 | check_missing(\%map); |
569 | ||
570 | return if (!$need && !$optional); | |
bba1e4cb MCC |
571 | |
572 | printf("You should run:\n\n"); | |
4ea96d57 MCC |
573 | |
574 | my $imagemagick = "media-gfx/imagemagick svg png"; | |
575 | my $cairo = "media-gfx/graphviz cairo pdf"; | |
576 | my $portage_imagemagick = "/etc/portage/package.use/imagemagick"; | |
577 | my $portage_cairo = "/etc/portage/package.use/graphviz"; | |
578 | ||
e45a6317 | 579 | if (qx(grep imagemagick $portage_imagemagick 2>/dev/null) eq "") { |
4ea96d57 MCC |
580 | printf("\tsudo su -c 'echo \"$imagemagick\" > $portage_imagemagick'\n") |
581 | } | |
e45a6317 | 582 | if (qx(grep graphviz $portage_cairo 2>/dev/null) eq "") { |
4ea96d57 MCC |
583 | printf("\tsudo su -c 'echo \"$cairo\" > $portage_cairo'\n"); |
584 | } | |
585 | ||
bba1e4cb MCC |
586 | printf("\tsudo emerge --ask $install\n"); |
587 | ||
24071ac1 MCC |
588 | } |
589 | ||
590 | sub check_distros() | |
591 | { | |
592 | # Distro-specific hints | |
593 | if ($system_release =~ /Red Hat Enterprise Linux/) { | |
594 | give_redhat_hints; | |
595 | return; | |
596 | } | |
9b756a9d MCC |
597 | if ($system_release =~ /CentOS/) { |
598 | give_redhat_hints; | |
599 | return; | |
600 | } | |
601 | if ($system_release =~ /Scientific Linux/) { | |
602 | give_redhat_hints; | |
603 | return; | |
604 | } | |
605 | if ($system_release =~ /Oracle Linux Server/) { | |
606 | give_redhat_hints; | |
607 | return; | |
608 | } | |
24071ac1 MCC |
609 | if ($system_release =~ /Fedora/) { |
610 | give_redhat_hints; | |
611 | return; | |
612 | } | |
613 | if ($system_release =~ /Ubuntu/) { | |
614 | give_debian_hints; | |
615 | return; | |
616 | } | |
617 | if ($system_release =~ /Debian/) { | |
618 | give_debian_hints; | |
619 | return; | |
620 | } | |
621 | if ($system_release =~ /openSUSE/) { | |
622 | give_opensuse_hints; | |
623 | return; | |
624 | } | |
800d408a MCC |
625 | if ($system_release =~ /Mageia/) { |
626 | give_mageia_hints; | |
627 | return; | |
628 | } | |
24071ac1 MCC |
629 | if ($system_release =~ /Arch Linux/) { |
630 | give_arch_linux_hints; | |
631 | return; | |
632 | } | |
633 | if ($system_release =~ /Gentoo/) { | |
634 | give_gentoo_hints; | |
635 | return; | |
636 | } | |
637 | ||
638 | # | |
639 | # Fall-back to generic hint code for other distros | |
640 | # That's far from ideal, specially for LaTeX dependencies. | |
641 | # | |
642 | my %map = ( | |
643 | "sphinx-build" => "sphinx" | |
644 | ); | |
56e5a633 | 645 | check_missing_tex(2) if ($pdf); |
24071ac1 MCC |
646 | check_missing(\%map); |
647 | print "I don't know distro $system_release.\n"; | |
648 | print "So, I can't provide you a hint with the install procedure.\n"; | |
649 | print "There are likely missing dependencies.\n"; | |
650 | } | |
651 | ||
652 | # | |
653 | # Common dependencies | |
654 | # | |
655 | ||
2730ce01 SK |
656 | sub deactivate_help() |
657 | { | |
658 | printf "\tIf you want to exit the virtualenv, you can use:\n"; | |
659 | printf "\tdeactivate\n"; | |
660 | } | |
661 | ||
24071ac1 MCC |
662 | sub check_needs() |
663 | { | |
9b88ad54 MCC |
664 | # Check for needed programs/tools |
665 | check_sphinx(); | |
666 | ||
24071ac1 | 667 | if ($system_release) { |
9b88ad54 | 668 | print "Detected OS: $system_release.\n\n"; |
24071ac1 | 669 | } else { |
9b88ad54 | 670 | print "Unknown OS\n\n"; |
9b756a9d MCC |
671 | } |
672 | ||
9b88ad54 MCC |
673 | print "To upgrade Sphinx, use:\n\n" if ($rec_sphinx_upgrade); |
674 | ||
24071ac1 | 675 | # Check for needed programs/tools |
24071ac1 MCC |
676 | check_perl_module("Pod::Usage", 0); |
677 | check_program("make", 0); | |
678 | check_program("gcc", 0); | |
679 | check_python_module("sphinx_rtd_theme", 1) if (!$virtualenv); | |
24071ac1 MCC |
680 | check_program("dot", 1); |
681 | check_program("convert", 1); | |
56e5a633 MCC |
682 | |
683 | # Extra PDF files - should use 2 for is_optional | |
684 | check_program("xelatex", 2) if ($pdf); | |
685 | check_program("rsvg-convert", 2) if ($pdf); | |
686 | check_program("latexmk", 2) if ($pdf); | |
24071ac1 MCC |
687 | |
688 | check_distros(); | |
689 | ||
690 | if ($need_symlink) { | |
691 | printf "\tsudo ln -sf %s /usr/bin/sphinx-build\n\n", | |
692 | which("sphinx-build-3"); | |
693 | } | |
77d09ad9 | 694 | if ($need_sphinx || $rec_sphinx_upgrade) { |
44f42165 | 695 | my $min_activate = "$ENV{'PWD'}/${virtenv_prefix}${min_version}/bin/activate"; |
9b88ad54 | 696 | my @activates = glob "$ENV{'PWD'}/${virtenv_prefix}*/bin/activate"; |
44f42165 | 697 | |
9b88ad54 | 698 | @activates = sort {$b cmp $a} @activates; |
44f42165 | 699 | |
9b88ad54 MCC |
700 | if ($need_sphinx && scalar @activates > 0 && $activates[0] ge $min_activate) { |
701 | printf "\nNeed to activate a compatible Sphinx version on virtualenv with:\n"; | |
44f42165 | 702 | printf "\t. $activates[0]\n"; |
2730ce01 | 703 | deactivate_help(); |
9b88ad54 | 704 | exit (1); |
5be33182 | 705 | } else { |
44f42165 | 706 | my $rec_activate = "$virtenv_dir/bin/activate"; |
5be33182 | 707 | my $virtualenv = findprog("virtualenv-3"); |
c428cd52 | 708 | my $rec_python3 = ""; |
800d408a | 709 | $virtualenv = findprog("virtualenv-3.5") if (!$virtualenv); |
5be33182 MCC |
710 | $virtualenv = findprog("virtualenv") if (!$virtualenv); |
711 | $virtualenv = "virtualenv" if (!$virtualenv); | |
712 | ||
c428cd52 TB |
713 | my $rel = ""; |
714 | if (index($system_release, "Ubuntu") != -1) { | |
715 | $rel = $1 if ($system_release =~ /Ubuntu\s+(\d+)[.]/); | |
716 | if ($rel && $rel >= 16) { | |
717 | $rec_python3 = " -p python3"; | |
718 | } | |
719 | } | |
720 | if (index($system_release, "Debian") != -1) { | |
721 | $rel = $1 if ($system_release =~ /Debian\s+(\d+)/); | |
722 | if ($rel && $rel >= 7) { | |
723 | $rec_python3 = " -p python3"; | |
724 | } | |
725 | } | |
726 | ||
727 | printf "\t$virtualenv$rec_python3 $virtenv_dir\n"; | |
44f42165 | 728 | printf "\t. $rec_activate\n"; |
fb947f3f | 729 | printf "\tpip install -r $requirement_file\n"; |
2730ce01 | 730 | deactivate_help(); |
77d09ad9 MCC |
731 | |
732 | $need++ if (!$rec_sphinx_upgrade); | |
5be33182 | 733 | } |
24071ac1 MCC |
734 | } |
735 | printf "\n"; | |
736 | ||
54002b56 | 737 | print "All optional dependencies are met.\n" if (!$optional); |
24071ac1 MCC |
738 | |
739 | if ($need == 1) { | |
740 | die "Can't build as $need mandatory dependency is missing"; | |
741 | } elsif ($need) { | |
742 | die "Can't build as $need mandatory dependencies are missing"; | |
743 | } | |
744 | ||
745 | print "Needed package dependencies are met.\n"; | |
746 | } | |
747 | ||
748 | # | |
749 | # Main | |
750 | # | |
751 | ||
752 | while (@ARGV) { | |
753 | my $arg = shift(@ARGV); | |
754 | ||
755 | if ($arg eq "--no-virtualenv") { | |
756 | $virtualenv = 0; | |
757 | } elsif ($arg eq "--no-pdf"){ | |
758 | $pdf = 0; | |
9b88ad54 MCC |
759 | } elsif ($arg eq "--version-check"){ |
760 | $version_check = 1; | |
24071ac1 | 761 | } else { |
9b88ad54 MCC |
762 | print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf> <--version-check>\n\n"; |
763 | print "Where:\n"; | |
764 | print "\t--no-virtualenv\t- Recommend installing Sphinx instead of using a virtualenv\n"; | |
765 | print "\t--version-check\t- if version is compatible, don't check for missing dependencies\n"; | |
766 | print "\t--no-pdf\t- don't check for dependencies required to build PDF docs\n\n"; | |
24071ac1 MCC |
767 | exit -1; |
768 | } | |
769 | } | |
770 | ||
771 | # | |
772 | # Determine the system type. There's no standard unique way that would | |
773 | # work with all distros with a minimal package install. So, several | |
774 | # methods are used here. | |
775 | # | |
776 | # By default, it will use lsb_release function. If not available, it will | |
777 | # fail back to reading the known different places where the distro name | |
778 | # is stored | |
779 | # | |
780 | ||
781 | $system_release = qx(lsb_release -d) if which("lsb_release"); | |
782 | $system_release =~ s/Description:\s*// if ($system_release); | |
783 | $system_release = catcheck("/etc/system-release") if !$system_release; | |
784 | $system_release = catcheck("/etc/redhat-release") if !$system_release; | |
785 | $system_release = catcheck("/etc/lsb-release") if !$system_release; | |
786 | $system_release = catcheck("/etc/gentoo-release") if !$system_release; | |
d14d0c1a MCC |
787 | |
788 | # This seems more common than LSB these days | |
789 | if (!$system_release) { | |
790 | my %os_var; | |
791 | if (open IN, "cat /etc/os-release|") { | |
792 | while (<IN>) { | |
793 | if (m/^([\w\d\_]+)=\"?([^\"]*)\"?\n/) { | |
794 | $os_var{$1}=$2; | |
795 | } | |
796 | } | |
797 | $system_release = $os_var{"NAME"}; | |
798 | if (defined($os_var{"VERSION_ID"})) { | |
799 | $system_release .= " " . $os_var{"VERSION_ID"} if (defined($os_var{"VERSION_ID"})); | |
800 | } else { | |
801 | $system_release .= " " . $os_var{"VERSION"}; | |
802 | } | |
803 | } | |
804 | } | |
24071ac1 MCC |
805 | $system_release = catcheck("/etc/issue") if !$system_release; |
806 | $system_release =~ s/\s+$//; | |
807 | ||
808 | check_needs; |