/usr/share/doc/python3-certbot-apache/html/_modules/certbot_apache/parser.html is in python-certbot-apache-doc 0.23.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>certbot_apache.parser — certbot-apache 0 documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../../genindex.html"/>
<link rel="search" title="Search" href="../../search.html"/>
<link rel="top" title="certbot-apache 0 documentation" href="../../index.html"/>
<link rel="up" title="Module code" href="../index.html"/>
<script src="../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../../index.html" class="icon icon-home"> certbot-apache
</a>
<div class="version">
0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../api.html">API Documentation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">certbot-apache</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> »</li>
<li><a href="../index.html">Module code</a> »</li>
<li>certbot_apache.parser</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for certbot_apache.parser</h1><div class="highlight"><pre>
<span></span><span class="sd">"""ApacheParser is a member object of the ApacheConfigurator class."""</span>
<span class="kn">import</span> <span class="nn">copy</span>
<span class="kn">import</span> <span class="nn">fnmatch</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">six</span>
<span class="kn">from</span> <span class="nn">certbot</span> <span class="k">import</span> <span class="n">errors</span>
<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<div class="viewcode-block" id="ApacheParser"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser">[docs]</a><span class="k">class</span> <span class="nc">ApacheParser</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Class handles the fine details of parsing the Apache Configuration.</span>
<span class="sd"> .. todo:: Make parsing general... remove sites-available etc...</span>
<span class="sd"> :ivar str root: Normalized absolute path to the server root</span>
<span class="sd"> directory. Without trailing slash.</span>
<span class="sd"> :ivar set modules: All module names that are currently enabled.</span>
<span class="sd"> :ivar dict loc: Location to place directives, root - configuration origin,</span>
<span class="sd"> default - user config file, name - NameVirtualHost,</span>
<span class="sd"> """</span>
<span class="n">arg_var_interpreter</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">"\$\{[^ \}]*}"</span><span class="p">)</span>
<span class="n">fnmatch_chars</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="s2">"*"</span><span class="p">,</span> <span class="s2">"?"</span><span class="p">,</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"["</span><span class="p">,</span> <span class="s2">"]"</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aug</span><span class="p">,</span> <span class="n">root</span><span class="p">,</span> <span class="n">vhostroot</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">),</span>
<span class="n">configurator</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># Note: Order is important here.</span>
<span class="c1"># Needed for calling save() with reverter functionality that resides in</span>
<span class="c1"># AugeasConfigurator superclass of ApacheConfigurator. This resolves</span>
<span class="c1"># issues with aug.load() after adding new files / defines to parse tree</span>
<span class="bp">self</span><span class="o">.</span><span class="n">configurator</span> <span class="o">=</span> <span class="n">configurator</span>
<span class="bp">self</span><span class="o">.</span><span class="n">modules</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser_paths</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">variables</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span> <span class="o">=</span> <span class="n">aug</span>
<span class="c1"># Find configuration root and make sure augeas can parse it.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">root</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">loc</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"root"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_find_config_root</span><span class="p">()}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parse_file</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"root"</span><span class="p">])</span>
<span class="k">if</span> <span class="n">version</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">):</span>
<span class="c1"># Look up variables from httpd and add to DOM if not already parsed</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update_runtime_variables</span><span class="p">()</span>
<span class="c1"># This problem has been fixed in Augeas 1.0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">standardize_excl</span><span class="p">()</span>
<span class="c1"># Parse LoadModule directives from configuration files</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parse_modules</span><span class="p">()</span>
<span class="c1"># Set up rest of locations</span>
<span class="bp">self</span><span class="o">.</span><span class="n">loc</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_set_locations</span><span class="p">())</span>
<span class="c1"># list of the active include paths, before modifications</span>
<span class="bp">self</span><span class="o">.</span><span class="n">existing_paths</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parser_paths</span><span class="p">)</span>
<span class="c1"># Must also attempt to parse additional virtual host root</span>
<span class="k">if</span> <span class="n">vhostroot</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parse_file</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">vhostroot</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"/"</span> <span class="o">+</span>
<span class="bp">self</span><span class="o">.</span><span class="n">configurator</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"vhost_files"</span><span class="p">))</span>
<span class="c1"># check to see if there were unparsed define statements</span>
<span class="k">if</span> <span class="n">version</span> <span class="o"><</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"Define"</span><span class="p">,</span> <span class="n">exclude</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span><span class="s2">"Error parsing runtime variables"</span><span class="p">)</span>
<div class="viewcode-block" id="ApacheParser.add_include"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.add_include">[docs]</a> <span class="k">def</span> <span class="nf">add_include</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">main_config</span><span class="p">,</span> <span class="n">inc_path</span><span class="p">):</span>
<span class="sd">"""Add Include for a new configuration file if one does not exist</span>
<span class="sd"> :param str main_config: file path to main Apache config file</span>
<span class="sd"> :param str inc_path: path of file to include</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="n">case_i</span><span class="p">(</span><span class="s2">"Include"</span><span class="p">),</span> <span class="n">inc_path</span><span class="p">))</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Adding Include </span><span class="si">%s</span><span class="s2"> to </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span>
<span class="n">inc_path</span><span class="p">,</span> <span class="n">get_aug_path</span><span class="p">(</span><span class="n">main_config</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_dir</span><span class="p">(</span>
<span class="n">get_aug_path</span><span class="p">(</span><span class="n">main_config</span><span class="p">),</span>
<span class="s2">"Include"</span><span class="p">,</span> <span class="n">inc_path</span><span class="p">)</span>
<span class="c1"># Add new path to parser paths</span>
<span class="n">new_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">inc_path</span><span class="p">)</span>
<span class="n">new_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">inc_path</span><span class="p">)</span>
<span class="k">if</span> <span class="n">new_dir</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">existing_paths</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
<span class="c1"># Add to existing path</span>
<span class="bp">self</span><span class="o">.</span><span class="n">existing_paths</span><span class="p">[</span><span class="n">new_dir</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">new_file</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Create a new path</span>
<span class="bp">self</span><span class="o">.</span><span class="n">existing_paths</span><span class="p">[</span><span class="n">new_dir</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="n">new_file</span><span class="p">]</span></div>
<div class="viewcode-block" id="ApacheParser.add_mod"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.add_mod">[docs]</a> <span class="k">def</span> <span class="nf">add_mod</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mod_name</span><span class="p">):</span>
<span class="sd">"""Shortcut for updating parser modules."""</span>
<span class="k">if</span> <span class="n">mod_name</span> <span class="o">+</span> <span class="s2">"_module"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">modules</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">mod_name</span> <span class="o">+</span> <span class="s2">"_module"</span><span class="p">)</span>
<span class="k">if</span> <span class="s2">"mod_"</span> <span class="o">+</span> <span class="n">mod_name</span> <span class="o">+</span> <span class="s2">".c"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">modules</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s2">"mod_"</span> <span class="o">+</span> <span class="n">mod_name</span> <span class="o">+</span> <span class="s2">".c"</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheParser.reset_modules"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.reset_modules">[docs]</a> <span class="k">def</span> <span class="nf">reset_modules</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Reset the loaded modules list. This is called from cleanup to clear</span>
<span class="sd"> temporarily loaded modules."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">modules</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update_modules</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parse_modules</span><span class="p">()</span></div>
<div class="viewcode-block" id="ApacheParser.parse_modules"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.parse_modules">[docs]</a> <span class="k">def</span> <span class="nf">parse_modules</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Iterates on the configuration until no new modules are loaded.</span>
<span class="sd"> ..todo:: This should be attempted to be done with a binary to avoid</span>
<span class="sd"> the iteration issue. Else... parse and enable mods at same time.</span>
<span class="sd"> """</span>
<span class="n">mods</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="n">matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"LoadModule"</span><span class="p">)</span>
<span class="n">iterator</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">matches</span><span class="p">)</span>
<span class="c1"># Make sure prev_size != cur_size for do: while: iteration</span>
<span class="n">prev_size</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="n">mods</span><span class="p">)</span> <span class="o">!=</span> <span class="n">prev_size</span><span class="p">:</span>
<span class="n">prev_size</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">mods</span><span class="p">)</span>
<span class="k">for</span> <span class="n">match_name</span><span class="p">,</span> <span class="n">match_filename</span> <span class="ow">in</span> <span class="n">six</span><span class="o">.</span><span class="n">moves</span><span class="o">.</span><span class="n">zip</span><span class="p">(</span>
<span class="n">iterator</span><span class="p">,</span> <span class="n">iterator</span><span class="p">):</span>
<span class="n">mod_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_arg</span><span class="p">(</span><span class="n">match_name</span><span class="p">)</span>
<span class="n">mod_filename</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_arg</span><span class="p">(</span><span class="n">match_filename</span><span class="p">)</span>
<span class="k">if</span> <span class="n">mod_name</span> <span class="ow">and</span> <span class="n">mod_filename</span><span class="p">:</span>
<span class="n">mods</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">mod_name</span><span class="p">)</span>
<span class="n">mods</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">mod_filename</span><span class="p">)[:</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"c"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Could not read LoadModule directive from "</span> <span class="o">+</span>
<span class="s2">"Augeas path: </span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">match_name</span><span class="p">[</span><span class="mi">6</span><span class="p">:]))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">mods</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheParser.update_runtime_variables"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.update_runtime_variables">[docs]</a> <span class="k">def</span> <span class="nf">update_runtime_variables</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Update Includes, Defines and Includes from httpd config dump data"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update_defines</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update_includes</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update_modules</span><span class="p">()</span></div>
<div class="viewcode-block" id="ApacheParser.update_defines"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.update_defines">[docs]</a> <span class="k">def</span> <span class="nf">update_defines</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Get Defines from httpd process"""</span>
<span class="n">variables</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
<span class="n">define_cmd</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">configurator</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"apache_cmd"</span><span class="p">),</span> <span class="s2">"-t"</span><span class="p">,</span> <span class="s2">"-D"</span><span class="p">,</span>
<span class="s2">"DUMP_RUN_CFG"</span><span class="p">]</span>
<span class="n">matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parse_from_subprocess</span><span class="p">(</span><span class="n">define_cmd</span><span class="p">,</span> <span class="sa">r</span><span class="s2">"Define: ([^ \n]*)"</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">matches</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="s2">"DUMP_RUN_CFG"</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">for</span> <span class="n">match</span> <span class="ow">in</span> <span class="n">matches</span><span class="p">:</span>
<span class="k">if</span> <span class="n">match</span><span class="o">.</span><span class="n">count</span><span class="p">(</span><span class="s2">"="</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"Unexpected number of equal signs in "</span>
<span class="s2">"runtime config dump."</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span>
<span class="s2">"Error parsing Apache runtime variables"</span><span class="p">)</span>
<span class="n">parts</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">partition</span><span class="p">(</span><span class="s2">"="</span><span class="p">)</span>
<span class="n">variables</span><span class="p">[</span><span class="n">parts</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">=</span> <span class="n">parts</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">variables</span> <span class="o">=</span> <span class="n">variables</span></div>
<div class="viewcode-block" id="ApacheParser.update_includes"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.update_includes">[docs]</a> <span class="k">def</span> <span class="nf">update_includes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Get includes from httpd process, and add them to DOM if needed"""</span>
<span class="c1"># Find_dir iterates over configuration for Include and IncludeOptional</span>
<span class="c1"># directives to make sure we see the full include tree present in the</span>
<span class="c1"># configuration files</span>
<span class="n">_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span><span class="s2">"Include"</span><span class="p">)</span>
<span class="n">inc_cmd</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">configurator</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"apache_cmd"</span><span class="p">),</span> <span class="s2">"-t"</span><span class="p">,</span> <span class="s2">"-D"</span><span class="p">,</span>
<span class="s2">"DUMP_INCLUDES"</span><span class="p">]</span>
<span class="n">matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parse_from_subprocess</span><span class="p">(</span><span class="n">inc_cmd</span><span class="p">,</span> <span class="sa">r</span><span class="s2">"\(.*\) (.*)"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">matches</span><span class="p">:</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">matches</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">parsed_in_current</span><span class="p">(</span><span class="n">i</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parse_file</span><span class="p">(</span><span class="n">i</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheParser.update_modules"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.update_modules">[docs]</a> <span class="k">def</span> <span class="nf">update_modules</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Get loaded modules from httpd process, and add them to DOM"""</span>
<span class="n">mod_cmd</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">configurator</span><span class="o">.</span><span class="n">constant</span><span class="p">(</span><span class="s2">"apache_cmd"</span><span class="p">),</span> <span class="s2">"-t"</span><span class="p">,</span> <span class="s2">"-D"</span><span class="p">,</span>
<span class="s2">"DUMP_MODULES"</span><span class="p">]</span>
<span class="n">matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parse_from_subprocess</span><span class="p">(</span><span class="n">mod_cmd</span><span class="p">,</span> <span class="sa">r</span><span class="s2">"(.*)_module"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">mod</span> <span class="ow">in</span> <span class="n">matches</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_mod</span><span class="p">(</span><span class="n">mod</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span></div>
<div class="viewcode-block" id="ApacheParser.parse_from_subprocess"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.parse_from_subprocess">[docs]</a> <span class="k">def</span> <span class="nf">parse_from_subprocess</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span> <span class="n">regexp</span><span class="p">):</span>
<span class="sd">"""Get values from stdout of subprocess command</span>
<span class="sd"> :param list command: Command to run</span>
<span class="sd"> :param str regexp: Regexp for parsing</span>
<span class="sd"> :returns: list parsed from command output</span>
<span class="sd"> :rtype: list</span>
<span class="sd"> """</span>
<span class="n">stdout</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_runtime_cfg</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
<span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">regexp</span><span class="p">)</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="n">stdout</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheParser._get_runtime_cfg"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser._get_runtime_cfg">[docs]</a> <span class="k">def</span> <span class="nf">_get_runtime_cfg</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span> <span class="c1"># pylint: disable=no-self-use</span>
<span class="sd">"""Get runtime configuration info.</span>
<span class="sd"> :param command: Command to run</span>
<span class="sd"> :returns: stdout from command</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">proc</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span>
<span class="n">command</span><span class="p">,</span>
<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
<span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
<span class="n">universal_newlines</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">stdout</span><span class="p">,</span> <span class="n">stderr</span> <span class="o">=</span> <span class="n">proc</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
<span class="k">except</span> <span class="p">(</span><span class="ne">OSError</span><span class="p">,</span> <span class="ne">ValueError</span><span class="p">):</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
<span class="s2">"Error running command </span><span class="si">%s</span><span class="s2"> for runtime parameters!</span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span>
<span class="n">command</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">MisconfigurationError</span><span class="p">(</span>
<span class="s2">"Error accessing loaded Apache parameters: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span>
<span class="n">command</span><span class="p">)</span>
<span class="c1"># Small errors that do not impede</span>
<span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">returncode</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">"Error in checking parameter list: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">stderr</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">MisconfigurationError</span><span class="p">(</span>
<span class="s2">"Apache is unable to check whether or not the module is "</span>
<span class="s2">"loaded because Apache is misconfigured."</span><span class="p">)</span>
<span class="k">return</span> <span class="n">stdout</span></div>
<div class="viewcode-block" id="ApacheParser.filter_args_num"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.filter_args_num">[docs]</a> <span class="k">def</span> <span class="nf">filter_args_num</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">matches</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span> <span class="c1"># pylint: disable=no-self-use</span>
<span class="sd">"""Filter out directives with specific number of arguments.</span>
<span class="sd"> This function makes the assumption that all related arguments are given</span>
<span class="sd"> in order. Thus /files/apache/directive[5]/arg[2] must come immediately</span>
<span class="sd"> after /files/apache/directive[5]/arg[1]. Runs in 1 linear pass.</span>
<span class="sd"> :param string matches: Matches of all directives with arg nodes</span>
<span class="sd"> :param int args: Number of args you would like to filter</span>
<span class="sd"> :returns: List of directives that contain # of arguments.</span>
<span class="sd"> (arg is stripped off)</span>
<span class="sd"> """</span>
<span class="n">filtered</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">args</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">matches</span><span class="p">)):</span>
<span class="k">if</span> <span class="n">matches</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"/arg"</span><span class="p">):</span>
<span class="n">filtered</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">matches</span><span class="p">[</span><span class="n">i</span><span class="p">][:</span><span class="o">-</span><span class="mi">4</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">matches</span><span class="p">)):</span>
<span class="k">if</span> <span class="n">matches</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"/arg[</span><span class="si">%d</span><span class="s2">]"</span> <span class="o">%</span> <span class="n">args</span><span class="p">):</span>
<span class="c1"># Make sure we don't cause an IndexError (end of list)</span>
<span class="c1"># Check to make sure arg + 1 doesn't exist</span>
<span class="k">if</span> <span class="p">(</span><span class="n">i</span> <span class="o">==</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">matches</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="ow">or</span>
<span class="ow">not</span> <span class="n">matches</span><span class="p">[</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"/arg[</span><span class="si">%d</span><span class="s2">]"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">args</span> <span class="o">+</span> <span class="mi">1</span><span class="p">))):</span>
<span class="n">filtered</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">matches</span><span class="p">[</span><span class="n">i</span><span class="p">][:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s2">"/arg[</span><span class="si">%d</span><span class="s2">]"</span> <span class="o">%</span> <span class="n">args</span><span class="p">)])</span>
<span class="k">return</span> <span class="n">filtered</span></div>
<div class="viewcode-block" id="ApacheParser.add_dir_to_ifmodssl"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.add_dir_to_ifmodssl">[docs]</a> <span class="k">def</span> <span class="nf">add_dir_to_ifmodssl</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aug_conf_path</span><span class="p">,</span> <span class="n">directive</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="sd">"""Adds directive and value to IfMod ssl block.</span>
<span class="sd"> Adds given directive and value along configuration path within</span>
<span class="sd"> an IfMod mod_ssl.c block. If the IfMod block does not exist in</span>
<span class="sd"> the file, it is created.</span>
<span class="sd"> :param str aug_conf_path: Desired Augeas config path to add directive</span>
<span class="sd"> :param str directive: Directive you would like to add, e.g. Listen</span>
<span class="sd"> :param args: Values of the directive; str "443" or list of str</span>
<span class="sd"> :type args: list</span>
<span class="sd"> """</span>
<span class="c1"># TODO: Add error checking code... does the path given even exist?</span>
<span class="c1"># Does it throw exceptions?</span>
<span class="n">if_mod_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_ifmod</span><span class="p">(</span><span class="n">aug_conf_path</span><span class="p">,</span> <span class="s2">"mod_ssl.c"</span><span class="p">)</span>
<span class="c1"># IfModule can have only one valid argument, so append after</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">if_mod_path</span> <span class="o">+</span> <span class="s2">"arg"</span><span class="p">,</span> <span class="s2">"directive"</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="n">nvh_path</span> <span class="o">=</span> <span class="n">if_mod_path</span> <span class="o">+</span> <span class="s2">"directive[1]"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">nvh_path</span><span class="p">,</span> <span class="n">directive</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">nvh_path</span> <span class="o">+</span> <span class="s2">"/arg"</span><span class="p">,</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">arg</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">args</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2">/arg[</span><span class="si">%d</span><span class="s2">]"</span> <span class="o">%</span> <span class="p">(</span><span class="n">nvh_path</span><span class="p">,</span> <span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">),</span> <span class="n">arg</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheParser._get_ifmod"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser._get_ifmod">[docs]</a> <span class="k">def</span> <span class="nf">_get_ifmod</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aug_conf_path</span><span class="p">,</span> <span class="n">mod</span><span class="p">):</span>
<span class="sd">"""Returns the path to <IfMod mod> and creates one if it doesn't exist.</span>
<span class="sd"> :param str aug_conf_path: Augeas configuration path</span>
<span class="sd"> :param str mod: module ie. mod_ssl.c</span>
<span class="sd"> """</span>
<span class="n">if_mods</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">((</span><span class="s2">"</span><span class="si">%s</span><span class="s2">/IfModule/*[self::arg='</span><span class="si">%s</span><span class="s2">']"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">aug_conf_path</span><span class="p">,</span> <span class="n">mod</span><span class="p">)))</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">if_mods</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2">/IfModule[last() + 1]"</span> <span class="o">%</span> <span class="n">aug_conf_path</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2">/IfModule[last()]/arg"</span> <span class="o">%</span> <span class="n">aug_conf_path</span><span class="p">,</span> <span class="n">mod</span><span class="p">)</span>
<span class="n">if_mods</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">((</span><span class="s2">"</span><span class="si">%s</span><span class="s2">/IfModule/*[self::arg='</span><span class="si">%s</span><span class="s2">']"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">aug_conf_path</span><span class="p">,</span> <span class="n">mod</span><span class="p">)))</span>
<span class="c1"># Strip off "arg" at end of first ifmod path</span>
<span class="k">return</span> <span class="n">if_mods</span><span class="p">[</span><span class="mi">0</span><span class="p">][:</span><span class="nb">len</span><span class="p">(</span><span class="n">if_mods</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">-</span> <span class="mi">3</span><span class="p">]</span></div>
<div class="viewcode-block" id="ApacheParser.add_dir"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.add_dir">[docs]</a> <span class="k">def</span> <span class="nf">add_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aug_conf_path</span><span class="p">,</span> <span class="n">directive</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="sd">"""Appends directive to the end fo the file given by aug_conf_path.</span>
<span class="sd"> .. note:: Not added to AugeasConfigurator because it may depend</span>
<span class="sd"> on the lens</span>
<span class="sd"> :param str aug_conf_path: Augeas configuration path to add directive</span>
<span class="sd"> :param str directive: Directive to add</span>
<span class="sd"> :param args: Value of the directive. ie. Listen 443, 443 is arg</span>
<span class="sd"> :type args: list or str</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">aug_conf_path</span> <span class="o">+</span> <span class="s2">"/directive[last() + 1]"</span><span class="p">,</span> <span class="n">directive</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="mi">1</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span>
<span class="s2">"</span><span class="si">%s</span><span class="s2">/directive[last()]/arg[</span><span class="si">%d</span><span class="s2">]"</span> <span class="o">%</span> <span class="p">(</span><span class="n">aug_conf_path</span><span class="p">,</span> <span class="n">i</span><span class="p">),</span> <span class="n">value</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">aug_conf_path</span> <span class="o">+</span> <span class="s2">"/directive[last()]/arg"</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheParser.add_dir_beginning"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.add_dir_beginning">[docs]</a> <span class="k">def</span> <span class="nf">add_dir_beginning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">aug_conf_path</span><span class="p">,</span> <span class="n">dirname</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="sd">"""Adds the directive to the beginning of defined aug_conf_path.</span>
<span class="sd"> :param str aug_conf_path: Augeas configuration path to add directive</span>
<span class="sd"> :param str dirname: Directive to add</span>
<span class="sd"> :param args: Value of the directive. ie. Listen 443, 443 is arg</span>
<span class="sd"> :type args: list or str</span>
<span class="sd"> """</span>
<span class="n">first_dir</span> <span class="o">=</span> <span class="n">aug_conf_path</span> <span class="o">+</span> <span class="s2">"/directive[1]"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">first_dir</span><span class="p">,</span> <span class="s2">"directive"</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">first_dir</span><span class="p">,</span> <span class="n">dirname</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="mi">1</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">first_dir</span> <span class="o">+</span> <span class="s2">"/arg[</span><span class="si">%d</span><span class="s2">]"</span> <span class="o">%</span> <span class="p">(</span><span class="n">i</span><span class="p">),</span> <span class="n">value</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">first_dir</span> <span class="o">+</span> <span class="s2">"/arg"</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheParser.find_dir"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.find_dir">[docs]</a> <span class="k">def</span> <span class="nf">find_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">directive</span><span class="p">,</span> <span class="n">arg</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">exclude</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""Finds directive in the configuration.</span>
<span class="sd"> Recursively searches through config files to find directives</span>
<span class="sd"> Directives should be in the form of a case insensitive regex currently</span>
<span class="sd"> .. todo:: arg should probably be a list</span>
<span class="sd"> .. todo:: arg search currently only supports direct matching. It does</span>
<span class="sd"> not handle the case of variables or quoted arguments. This should</span>
<span class="sd"> be adapted to use a generic search for the directive and then do a</span>
<span class="sd"> case-insensitive self.get_arg filter</span>
<span class="sd"> Note: Augeas is inherently case sensitive while Apache is case</span>
<span class="sd"> insensitive. Augeas 1.0 allows case insensitive regexes like</span>
<span class="sd"> regexp(/Listen/, "i"), however the version currently supported</span>
<span class="sd"> by Ubuntu 0.10 does not. Thus I have included my own case insensitive</span>
<span class="sd"> transformation by calling case_i() on everything to maintain</span>
<span class="sd"> compatibility.</span>
<span class="sd"> :param str directive: Directive to look for</span>
<span class="sd"> :param arg: Specific value directive must have, None if all should</span>
<span class="sd"> be considered</span>
<span class="sd"> :type arg: str or None</span>
<span class="sd"> :param str start: Beginning Augeas path to begin looking</span>
<span class="sd"> :param bool exclude: Whether or not to exclude directives based on</span>
<span class="sd"> variables and enabled modules</span>
<span class="sd"> """</span>
<span class="c1"># Cannot place member variable in the definition of the function so...</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">start</span><span class="p">:</span>
<span class="n">start</span> <span class="o">=</span> <span class="n">get_aug_path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"root"</span><span class="p">])</span>
<span class="c1"># No regexp code</span>
<span class="c1"># if arg is None:</span>
<span class="c1"># matches = self.aug.match(start +</span>
<span class="c1"># "//*[self::directive='" + directive + "']/arg")</span>
<span class="c1"># else:</span>
<span class="c1"># matches = self.aug.match(start +</span>
<span class="c1"># "//*[self::directive='" + directive +</span>
<span class="c1"># "']/* [self::arg='" + arg + "']")</span>
<span class="c1"># includes = self.aug.match(start +</span>
<span class="c1"># "//* [self::directive='Include']/* [label()='arg']")</span>
<span class="n">regex</span> <span class="o">=</span> <span class="s2">"(</span><span class="si">%s</span><span class="s2">)|(</span><span class="si">%s</span><span class="s2">)|(</span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="n">case_i</span><span class="p">(</span><span class="n">directive</span><span class="p">),</span>
<span class="n">case_i</span><span class="p">(</span><span class="s2">"Include"</span><span class="p">),</span>
<span class="n">case_i</span><span class="p">(</span><span class="s2">"IncludeOptional"</span><span class="p">))</span>
<span class="n">matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span>
<span class="s2">"</span><span class="si">%s</span><span class="s2">//*[self::directive=~regexp('</span><span class="si">%s</span><span class="s2">')]"</span> <span class="o">%</span> <span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">regex</span><span class="p">))</span>
<span class="k">if</span> <span class="n">exclude</span><span class="p">:</span>
<span class="n">matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_exclude_dirs</span><span class="p">(</span><span class="n">matches</span><span class="p">)</span>
<span class="k">if</span> <span class="n">arg</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">arg_suffix</span> <span class="o">=</span> <span class="s2">"/arg"</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">arg_suffix</span> <span class="o">=</span> <span class="s2">"/*[self::arg=~regexp('</span><span class="si">%s</span><span class="s2">')]"</span> <span class="o">%</span> <span class="n">case_i</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span>
<span class="n">ordered_matches</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># TODO: Wildcards should be included in alphabetical order</span>
<span class="c1"># https://httpd.apache.org/docs/2.4/mod/core.html#include</span>
<span class="k">for</span> <span class="n">match</span> <span class="ow">in</span> <span class="n">matches</span><span class="p">:</span>
<span class="n">dir_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">match</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">if</span> <span class="n">dir_</span> <span class="o">==</span> <span class="s2">"include"</span> <span class="ow">or</span> <span class="n">dir_</span> <span class="o">==</span> <span class="s2">"includeoptional"</span><span class="p">:</span>
<span class="n">ordered_matches</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">find_dir</span><span class="p">(</span>
<span class="n">directive</span><span class="p">,</span> <span class="n">arg</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_get_include_path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_arg</span><span class="p">(</span><span class="n">match</span> <span class="o">+</span> <span class="s2">"/arg"</span><span class="p">)),</span>
<span class="n">exclude</span><span class="p">))</span>
<span class="c1"># This additionally allows Include</span>
<span class="k">if</span> <span class="n">dir_</span> <span class="o">==</span> <span class="n">directive</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span>
<span class="n">ordered_matches</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">match</span> <span class="o">+</span> <span class="n">arg_suffix</span><span class="p">))</span>
<span class="k">return</span> <span class="n">ordered_matches</span></div>
<div class="viewcode-block" id="ApacheParser.get_arg"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.get_arg">[docs]</a> <span class="k">def</span> <span class="nf">get_arg</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">match</span><span class="p">):</span>
<span class="sd">"""Uses augeas.get to get argument value and interprets result.</span>
<span class="sd"> This also converts all variables and parameters appropriately.</span>
<span class="sd"> """</span>
<span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">match</span><span class="p">)</span>
<span class="c1"># No need to strip quotes for variables, as apache2ctl already does</span>
<span class="c1"># this, but we do need to strip quotes for all normal arguments.</span>
<span class="c1"># Note: normal argument may be a quoted variable</span>
<span class="c1"># e.g. strip now, not later</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">value</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s2">"'</span><span class="se">\"</span><span class="s2">"</span><span class="p">)</span>
<span class="n">variables</span> <span class="o">=</span> <span class="n">ApacheParser</span><span class="o">.</span><span class="n">arg_var_interpreter</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">for</span> <span class="n">var</span> <span class="ow">in</span> <span class="n">variables</span><span class="p">:</span>
<span class="c1"># Strip off ${ and }</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">var</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">variables</span><span class="p">[</span><span class="n">var</span><span class="p">[</span><span class="mi">2</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]])</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">PluginError</span><span class="p">(</span><span class="s2">"Error Parsing variable: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">var</span><span class="p">)</span>
<span class="k">return</span> <span class="n">value</span></div>
<div class="viewcode-block" id="ApacheParser._exclude_dirs"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser._exclude_dirs">[docs]</a> <span class="k">def</span> <span class="nf">_exclude_dirs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">matches</span><span class="p">):</span>
<span class="sd">"""Exclude directives that are not loaded into the configuration."""</span>
<span class="n">filters</span> <span class="o">=</span> <span class="p">[(</span><span class="s2">"ifmodule"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">modules</span><span class="p">),</span> <span class="p">(</span><span class="s2">"ifdefine"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">variables</span><span class="p">)]</span>
<span class="n">valid_matches</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">match</span> <span class="ow">in</span> <span class="n">matches</span><span class="p">:</span>
<span class="k">for</span> <span class="n">filter_</span> <span class="ow">in</span> <span class="n">filters</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pass_filter</span><span class="p">(</span><span class="n">match</span><span class="p">,</span> <span class="n">filter_</span><span class="p">):</span>
<span class="k">break</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">valid_matches</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">match</span><span class="p">)</span>
<span class="k">return</span> <span class="n">valid_matches</span></div>
<div class="viewcode-block" id="ApacheParser._pass_filter"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser._pass_filter">[docs]</a> <span class="k">def</span> <span class="nf">_pass_filter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">match</span><span class="p">,</span> <span class="n">filter_</span><span class="p">):</span>
<span class="sd">"""Determine if directive passes a filter.</span>
<span class="sd"> :param str match: Augeas path</span>
<span class="sd"> :param list filter: list of tuples of form</span>
<span class="sd"> [("lowercase if directive", set of relevant parameters)]</span>
<span class="sd"> """</span>
<span class="n">match_l</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="n">last_match_idx</span> <span class="o">=</span> <span class="n">match_l</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">filter_</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">while</span> <span class="n">last_match_idx</span> <span class="o">!=</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
<span class="c1"># Check args</span>
<span class="n">end_of_if</span> <span class="o">=</span> <span class="n">match_l</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s2">"/"</span><span class="p">,</span> <span class="n">last_match_idx</span><span class="p">)</span>
<span class="c1"># This should be aug.get (vars are not used e.g. parser.aug_get)</span>
<span class="n">expression</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">match</span><span class="p">[:</span><span class="n">end_of_if</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"/arg"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">expression</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"!"</span><span class="p">):</span>
<span class="c1"># Strip off "!"</span>
<span class="k">if</span> <span class="n">expression</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="ow">in</span> <span class="n">filter_</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">expression</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">filter_</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="n">last_match_idx</span> <span class="o">=</span> <span class="n">match_l</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">filter_</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">end_of_if</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="ApacheParser._get_include_path"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser._get_include_path">[docs]</a> <span class="k">def</span> <span class="nf">_get_include_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">arg</span><span class="p">):</span>
<span class="sd">"""Converts an Apache Include directive into Augeas path.</span>
<span class="sd"> Converts an Apache Include directive argument into an Augeas</span>
<span class="sd"> searchable path</span>
<span class="sd"> .. todo:: convert to use os.path.join()</span>
<span class="sd"> :param str arg: Argument of Include directive</span>
<span class="sd"> :returns: Augeas path string</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> """</span>
<span class="c1"># Check to make sure only expected characters are used <- maybe remove</span>
<span class="c1"># validChars = re.compile("[a-zA-Z0-9.*?_-/]*")</span>
<span class="c1"># matchObj = validChars.match(arg)</span>
<span class="c1"># if matchObj.group() != arg:</span>
<span class="c1"># logger.error("Error: Invalid regexp characters in %s", arg)</span>
<span class="c1"># return []</span>
<span class="c1"># Remove beginning and ending quotes</span>
<span class="n">arg</span> <span class="o">=</span> <span class="n">arg</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s2">"'</span><span class="se">\"</span><span class="s2">"</span><span class="p">)</span>
<span class="c1"># Standardize the include argument based on server root</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">arg</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"/"</span><span class="p">):</span>
<span class="c1"># Normpath will condense ../</span>
<span class="n">arg</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">normpath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">,</span> <span class="n">arg</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">arg</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">normpath</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span>
<span class="c1"># Attempts to add a transform to the file if one does not already exist</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">arg</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parse_file</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">arg</span><span class="p">,</span> <span class="s2">"*"</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parse_file</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span>
<span class="c1"># Argument represents an fnmatch regular expression, convert it</span>
<span class="c1"># Split up the path and convert each into an Augeas accepted regex</span>
<span class="c1"># then reassemble</span>
<span class="n">split_arg</span> <span class="o">=</span> <span class="n">arg</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"/"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">split</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">split_arg</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">any</span><span class="p">(</span><span class="n">char</span> <span class="ow">in</span> <span class="n">ApacheParser</span><span class="o">.</span><span class="n">fnmatch_chars</span> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="n">split</span><span class="p">):</span>
<span class="c1"># Turn it into a augeas regex</span>
<span class="c1"># TODO: Can this instead be an augeas glob instead of regex</span>
<span class="n">split_arg</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"* [label()=~regexp('</span><span class="si">%s</span><span class="s2">')]"</span> <span class="o">%</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fnmatch_to_re</span><span class="p">(</span><span class="n">split</span><span class="p">))</span>
<span class="c1"># Reassemble the argument</span>
<span class="c1"># Note: This also normalizes the argument /serverroot/ -> /serverroot</span>
<span class="n">arg</span> <span class="o">=</span> <span class="s2">"/"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">split_arg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">get_aug_path</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheParser.fnmatch_to_re"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.fnmatch_to_re">[docs]</a> <span class="k">def</span> <span class="nf">fnmatch_to_re</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">clean_fn_match</span><span class="p">):</span> <span class="c1"># pylint: disable=no-self-use</span>
<span class="sd">"""Method converts Apache's basic fnmatch to regular expression.</span>
<span class="sd"> Assumption - Configs are assumed to be well-formed and only writable by</span>
<span class="sd"> privileged users.</span>
<span class="sd"> https://apr.apache.org/docs/apr/2.0/apr__fnmatch_8h_source.html</span>
<span class="sd"> http://apache2.sourcearchive.com/documentation/2.2.16-6/apr__fnmatch_8h_source.html</span>
<span class="sd"> :param str clean_fn_match: Apache style filename match, like globs</span>
<span class="sd"> :returns: regex suitable for augeas</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o"><</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">6</span><span class="p">):</span>
<span class="c1"># This strips off final /Z(?ms)</span>
<span class="k">return</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">translate</span><span class="p">(</span><span class="n">clean_fn_match</span><span class="p">)[:</span><span class="o">-</span><span class="mi">7</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span> <span class="c1"># pragma: no cover</span>
<span class="c1"># Since Python 3.6, it returns a different pattern like (?s:.*\.load)\Z</span>
<span class="k">return</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">translate</span><span class="p">(</span><span class="n">clean_fn_match</span><span class="p">)[</span><span class="mi">4</span><span class="p">:</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span></div>
<div class="viewcode-block" id="ApacheParser.parse_file"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.parse_file">[docs]</a> <span class="k">def</span> <span class="nf">parse_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filepath</span><span class="p">):</span>
<span class="sd">"""Parse file with Augeas</span>
<span class="sd"> Checks to see if file_path is parsed by Augeas</span>
<span class="sd"> If filepath isn't parsed, the file is added and Augeas is reloaded</span>
<span class="sd"> :param str filepath: Apache config file path</span>
<span class="sd"> """</span>
<span class="n">use_new</span><span class="p">,</span> <span class="n">remove_old</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_path_actions</span><span class="p">(</span><span class="n">filepath</span><span class="p">)</span>
<span class="c1"># Ensure that we have the latest Augeas DOM state on disk before</span>
<span class="c1"># calling aug.load() which reloads the state from disk</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">configurator</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">configurator</span><span class="o">.</span><span class="n">ensure_augeas_state</span><span class="p">()</span>
<span class="c1"># Test if augeas included file for Httpd.lens</span>
<span class="c1"># Note: This works for augeas globs, ie. *.conf</span>
<span class="k">if</span> <span class="n">use_new</span><span class="p">:</span>
<span class="n">inc_test</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span>
<span class="s2">"/augeas/load/Httpd['</span><span class="si">%s</span><span class="s2">' =~ glob(incl)]"</span> <span class="o">%</span> <span class="n">filepath</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">inc_test</span><span class="p">:</span>
<span class="c1"># Load up files</span>
<span class="c1"># This doesn't seem to work on TravisCI</span>
<span class="c1"># self.aug.add_transform("Httpd.lns", [filepath])</span>
<span class="k">if</span> <span class="n">remove_old</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_remove_httpd_transform</span><span class="p">(</span><span class="n">filepath</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_add_httpd_transform</span><span class="p">(</span><span class="n">filepath</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">load</span><span class="p">()</span></div>
<div class="viewcode-block" id="ApacheParser.parsed_in_current"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.parsed_in_current">[docs]</a> <span class="k">def</span> <span class="nf">parsed_in_current</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filep</span><span class="p">):</span>
<span class="sd">"""Checks if the file path is parsed by current Augeas parser config</span>
<span class="sd"> ie. returns True if the file is found on a path that's found in live</span>
<span class="sd"> Augeas configuration.</span>
<span class="sd"> :param str filep: Path to match</span>
<span class="sd"> :returns: True if file is parsed in existing configuration tree</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parsed_by_parser_paths</span><span class="p">(</span><span class="n">filep</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser_paths</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheParser.parsed_in_original"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.parsed_in_original">[docs]</a> <span class="k">def</span> <span class="nf">parsed_in_original</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filep</span><span class="p">):</span>
<span class="sd">"""Checks if the file path is parsed by existing Apache config.</span>
<span class="sd"> ie. returns True if the file is found on a path that matches Include or</span>
<span class="sd"> IncludeOptional statement in the Apache configuration.</span>
<span class="sd"> :param str filep: Path to match</span>
<span class="sd"> :returns: True if file is parsed in existing configuration tree</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parsed_by_parser_paths</span><span class="p">(</span><span class="n">filep</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">existing_paths</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheParser._parsed_by_parser_paths"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser._parsed_by_parser_paths">[docs]</a> <span class="k">def</span> <span class="nf">_parsed_by_parser_paths</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filep</span><span class="p">,</span> <span class="n">paths</span><span class="p">):</span>
<span class="sd">"""Helper function that searches through provided paths and returns</span>
<span class="sd"> True if file path is found in the set"""</span>
<span class="k">for</span> <span class="n">directory</span> <span class="ow">in</span> <span class="n">paths</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
<span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">paths</span><span class="p">[</span><span class="n">directory</span><span class="p">]:</span>
<span class="k">if</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">fnmatch</span><span class="p">(</span><span class="n">filep</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">directory</span><span class="p">,</span> <span class="n">filename</span><span class="p">)):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">return</span> <span class="kc">False</span></div>
<div class="viewcode-block" id="ApacheParser._check_path_actions"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser._check_path_actions">[docs]</a> <span class="k">def</span> <span class="nf">_check_path_actions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filepath</span><span class="p">):</span>
<span class="sd">"""Determine actions to take with a new augeas path</span>
<span class="sd"> This helper function will return a tuple that defines</span>
<span class="sd"> if we should try to append the new filepath to augeas</span>
<span class="sd"> parser paths, and / or remove the old one with more</span>
<span class="sd"> narrow matching.</span>
<span class="sd"> :param str filepath: filepath to check the actions for</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">new_file_match</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">filepath</span><span class="p">)</span>
<span class="n">existing_matches</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser_paths</span><span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">filepath</span><span class="p">)]</span>
<span class="k">if</span> <span class="s2">"*"</span> <span class="ow">in</span> <span class="n">existing_matches</span><span class="p">:</span>
<span class="n">use_new</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">use_new</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">if</span> <span class="n">new_file_match</span> <span class="o">==</span> <span class="s2">"*"</span><span class="p">:</span>
<span class="n">remove_old</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">remove_old</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="n">use_new</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">remove_old</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">return</span> <span class="n">use_new</span><span class="p">,</span> <span class="n">remove_old</span></div>
<div class="viewcode-block" id="ApacheParser._remove_httpd_transform"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser._remove_httpd_transform">[docs]</a> <span class="k">def</span> <span class="nf">_remove_httpd_transform</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filepath</span><span class="p">):</span>
<span class="sd">"""Remove path from Augeas transform</span>
<span class="sd"> :param str filepath: filepath to remove</span>
<span class="sd"> """</span>
<span class="n">remove_basenames</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser_paths</span><span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">filepath</span><span class="p">)]</span>
<span class="n">remove_dirname</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">filepath</span><span class="p">)</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">remove_basenames</span><span class="p">:</span>
<span class="n">remove_path</span> <span class="o">=</span> <span class="n">remove_dirname</span> <span class="o">+</span> <span class="s2">"/"</span> <span class="o">+</span> <span class="n">name</span>
<span class="n">remove_inc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span>
<span class="s2">"/augeas/load/Httpd/incl [. ='</span><span class="si">%s</span><span class="s2">']"</span> <span class="o">%</span> <span class="n">remove_path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">remove_inc</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser_paths</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">remove_dirname</span><span class="p">)</span></div>
<div class="viewcode-block" id="ApacheParser._add_httpd_transform"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser._add_httpd_transform">[docs]</a> <span class="k">def</span> <span class="nf">_add_httpd_transform</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">incl</span><span class="p">):</span>
<span class="sd">"""Add a transform to Augeas.</span>
<span class="sd"> This function will correctly add a transform to augeas</span>
<span class="sd"> The existing augeas.add_transform in python doesn't seem to work for</span>
<span class="sd"> Travis CI as it loads in libaugeas.so.0.10.0</span>
<span class="sd"> :param str incl: filepath to include for transform</span>
<span class="sd"> """</span>
<span class="n">last_include</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s2">"/augeas/load/Httpd/incl [last()]"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">last_include</span><span class="p">:</span>
<span class="c1"># Insert a new node immediately after the last incl</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">last_include</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s2">"incl"</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"/augeas/load/Httpd/incl[last()]"</span><span class="p">,</span> <span class="n">incl</span><span class="p">)</span>
<span class="c1"># On first use... must load lens and add file to incl</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Augeas uses base 1 indexing... insert at beginning...</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"/augeas/load/Httpd/lens"</span><span class="p">,</span> <span class="s2">"Httpd.lns"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"/augeas/load/Httpd/incl"</span><span class="p">,</span> <span class="n">incl</span><span class="p">)</span>
<span class="c1"># Add included path to paths dictionary</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser_paths</span><span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">incl</span><span class="p">)]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">incl</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parser_paths</span><span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">incl</span><span class="p">)]</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">incl</span><span class="p">)]</span></div>
<div class="viewcode-block" id="ApacheParser.standardize_excl"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser.standardize_excl">[docs]</a> <span class="k">def</span> <span class="nf">standardize_excl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Standardize the excl arguments for the Httpd lens in Augeas.</span>
<span class="sd"> Note: Hack!</span>
<span class="sd"> Standardize the excl arguments for the Httpd lens in Augeas</span>
<span class="sd"> Servers sometimes give incorrect defaults</span>
<span class="sd"> Note: This problem should be fixed in Augeas 1.0. Unfortunately,</span>
<span class="sd"> Augeas 0.10 appears to be the most popular version currently.</span>
<span class="sd"> """</span>
<span class="c1"># attempt to protect against augeas error in 0.10.0 - ubuntu</span>
<span class="c1"># *.augsave -> /*.augsave upon augeas.load()</span>
<span class="c1"># Try to avoid bad httpd files</span>
<span class="c1"># There has to be a better way... but after a day and a half of testing</span>
<span class="c1"># I had no luck</span>
<span class="c1"># This is a hack... work around... submit to augeas if still not fixed</span>
<span class="n">excl</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"*.augnew"</span><span class="p">,</span> <span class="s2">"*.augsave"</span><span class="p">,</span> <span class="s2">"*.dpkg-dist"</span><span class="p">,</span> <span class="s2">"*.dpkg-bak"</span><span class="p">,</span>
<span class="s2">"*.dpkg-new"</span><span class="p">,</span> <span class="s2">"*.dpkg-old"</span><span class="p">,</span> <span class="s2">"*.rpmsave"</span><span class="p">,</span> <span class="s2">"*.rpmnew"</span><span class="p">,</span>
<span class="s2">"*~"</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">+</span> <span class="s2">"/*.augsave"</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">+</span> <span class="s2">"/*~"</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">+</span> <span class="s2">"/*/*augsave"</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">+</span> <span class="s2">"/*/*~"</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">+</span> <span class="s2">"/*/*/*.augsave"</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">+</span> <span class="s2">"/*/*/*~"</span><span class="p">]</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">excluded</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">excl</span><span class="p">,</span> <span class="mi">1</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"/augeas/load/Httpd/excl[</span><span class="si">%d</span><span class="s2">]"</span> <span class="o">%</span> <span class="n">i</span><span class="p">,</span> <span class="n">excluded</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">aug</span><span class="o">.</span><span class="n">load</span><span class="p">()</span></div>
<div class="viewcode-block" id="ApacheParser._set_locations"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser._set_locations">[docs]</a> <span class="k">def</span> <span class="nf">_set_locations</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Set default location for directives.</span>
<span class="sd"> Locations are given as file_paths</span>
<span class="sd"> .. todo:: Make sure that files are included</span>
<span class="sd"> """</span>
<span class="n">default</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="s2">"root"</span><span class="p">]</span>
<span class="n">temp</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">,</span> <span class="s2">"ports.conf"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">temp</span><span class="p">):</span>
<span class="n">listen</span> <span class="o">=</span> <span class="n">temp</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">temp</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">listen</span> <span class="o">=</span> <span class="n">default</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">default</span>
<span class="k">return</span> <span class="p">{</span><span class="s2">"default"</span><span class="p">:</span> <span class="n">default</span><span class="p">,</span> <span class="s2">"listen"</span><span class="p">:</span> <span class="n">listen</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="n">name</span><span class="p">}</span></div>
<div class="viewcode-block" id="ApacheParser._find_config_root"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.ApacheParser._find_config_root">[docs]</a> <span class="k">def</span> <span class="nf">_find_config_root</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Find the Apache Configuration Root file."""</span>
<span class="n">location</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"apache2.conf"</span><span class="p">,</span> <span class="s2">"httpd.conf"</span><span class="p">,</span> <span class="s2">"conf/httpd.conf"</span><span class="p">]</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">location</span><span class="p">:</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">,</span> <span class="n">name</span><span class="p">)):</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">errors</span><span class="o">.</span><span class="n">NoInstallationError</span><span class="p">(</span><span class="s2">"Could not find configuration root"</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="case_i"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.case_i">[docs]</a><span class="k">def</span> <span class="nf">case_i</span><span class="p">(</span><span class="n">string</span><span class="p">):</span>
<span class="sd">"""Returns case insensitive regex.</span>
<span class="sd"> Returns a sloppy, but necessary version of a case insensitive regex.</span>
<span class="sd"> Any string should be able to be submitted and the string is</span>
<span class="sd"> escaped and then made case insensitive.</span>
<span class="sd"> May be replaced by a more proper /i once augeas 1.0 is widely</span>
<span class="sd"> supported.</span>
<span class="sd"> :param str string: string to make case i regex</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s2">"["</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">+</span> <span class="s2">"]"</span>
<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">isalpha</span><span class="p">()</span> <span class="k">else</span> <span class="n">c</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">re</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">string</span><span class="p">)])</span></div>
<div class="viewcode-block" id="get_aug_path"><a class="viewcode-back" href="../../api/parser.html#certbot_apache.parser.get_aug_path">[docs]</a><span class="k">def</span> <span class="nf">get_aug_path</span><span class="p">(</span><span class="n">file_path</span><span class="p">):</span>
<span class="sd">"""Return augeas path for full filepath.</span>
<span class="sd"> :param str file_path: Full filepath</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="s2">"/files</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">file_path</span></div>
</pre></div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014-2018, Let's Encrypt Project.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|