Merge pull request #2523 from WPO-Foundation/dirmenot

Replacing `__DIR__` with constants, part 2
catchpoint · Jan 10, 2023 · b0f59d2 · b0f59d2
2 parents 5758c7a + 934c72d
commit b0f59d2
Show file tree

Hide file tree

Showing 47 changed files with 204 additions and 207 deletions.
diff --git a/www/har/HttpArchiveGenerator.php b/www/har/HttpArchiveGenerator.php
@@ -4,10 +4,10 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/../common_lib.inc';
-require_once __DIR__ . '/../object_detail.inc';
-require_once __DIR__ . '/../include/TestResults.php';
-require_once __DIR__ . '/../include/Browser.php';
+require_once INCLUDES_PATH . '/common_lib.inc';
+require_once INCLUDES_PATH . '/object_detail.inc';
+require_once INCLUDES_PATH . '/include/TestResults.php';
+require_once INCLUDES_PATH . '/include/Browser.php';
 
 /**
  * Creates HttpArchives from test data.

diff --git a/www/include/ConnectionViewHtmlSnippet.php b/www/include/ConnectionViewHtmlSnippet.php
@@ -4,7 +4,7 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/../waterfall.inc';
+require_once INCLUDES_PATH . '/waterfall.inc';
 
 class ConnectionViewHtmlSnippet
 {

diff --git a/www/include/DomainBreakdownHtmlSnippet.php b/www/include/DomainBreakdownHtmlSnippet.php
@@ -4,7 +4,7 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/BreakdownHtmlSnippet.php';
+require_once INCLUDES_PATH . '/include/BreakdownHtmlSnippet.php';
 
 class DomainBreakdownHtmlSnippet extends BreakdownHtmlSnippet
 {

diff --git a/www/include/MimetypeBreakdownHtmlSnippet.php b/www/include/MimetypeBreakdownHtmlSnippet.php
@@ -4,8 +4,8 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/BreakdownHtmlSnippet.php';
-require_once __DIR__ . '/ConnectionViewHtmlSnippet.php';
+require_once INCLUDES_PATH . '/include/BreakdownHtmlSnippet.php';
+require_once INCLUDES_PATH . '/include/ConnectionViewHtmlSnippet.php';
 
 class MimetypeBreakdownHtmlSnippet extends BreakdownHtmlSnippet
 {

diff --git a/www/include/PerformanceOptimizationHtmlSnippet.php b/www/include/PerformanceOptimizationHtmlSnippet.php
@@ -3,7 +3,7 @@
 // Copyright 2020 Catchpoint Systems Inc.
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
-require_once __DIR__ . '/../optimization.inc';
+require_once INCLUDES_PATH . '/optimization.inc';
 
 class PerformanceOptimizationHtmlSnippet
 {

diff --git a/www/include/ResultProcessing.php b/www/include/ResultProcessing.php
@@ -4,11 +4,11 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/../common_lib.inc';
-require_once __DIR__ . '/../page_data.inc';
-require_once __DIR__ . '/../object_detail.inc';
-require_once __DIR__ . '/../breakdown.inc';
-require_once __DIR__ . '/../devtools.inc.php';
+require_once INCLUDES_PATH . '/common_lib.inc';
+require_once INCLUDES_PATH . '/page_data.inc';
+require_once INCLUDES_PATH . '/object_detail.inc';
+require_once INCLUDES_PATH . '/breakdown.inc';
+require_once INCLUDES_PATH . '/devtools.inc.php';
 
 class ResultProcessing
 {

diff --git a/www/include/RunResultHtmlTable.php b/www/include/RunResultHtmlTable.php
@@ -4,7 +4,7 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/../common_lib.inc';
+require_once INCLUDES_PATH . '/common_lib.inc';
 
 class RunResultHtmlTable
 {

diff --git a/www/include/TestInfo.php b/www/include/TestInfo.php
@@ -4,7 +4,7 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/../common_lib.inc'; // TODO: remove if we don't use GetTestInfo anymore
+require_once INCLUDES_PATH . '/common_lib.inc'; // TODO: remove if we don't use GetTestInfo anymore
 
 class TestInfo
 {

diff --git a/www/include/TestResults.php b/www/include/TestResults.php
@@ -4,10 +4,10 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/FileHandler.php';
-require_once __DIR__ . '/TestStepResult.php';
-require_once __DIR__ . '/TestRunResults.php';
-require_once __DIR__ . '/Browser.php';
+require_once INCLUDES_PATH . '/include/FileHandler.php';
+require_once INCLUDES_PATH . '/include/TestStepResult.php';
+require_once INCLUDES_PATH . '/include/TestRunResults.php';
+require_once INCLUDES_PATH . '/include/Browser.php';
 
 
 class TestResults

diff --git a/www/include/TestResultsHtmlTables.php b/www/include/TestResultsHtmlTables.php
@@ -4,7 +4,7 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/../common_lib.inc';
+require_once INCLUDES_PATH . '/common_lib.inc';
 
 class TestResultsHtmlTables
 {

diff --git a/www/include/TestRunResults.php b/www/include/TestRunResults.php
@@ -4,7 +4,7 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/TestStepResult.php';
+require_once INCLUDES_PATH . '/include/TestStepResult.php';
 
 class TestRunResults
 {

diff --git a/www/include/TestStepResult.php b/www/include/TestStepResult.php
@@ -4,11 +4,11 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/FileHandler.php';
-require_once __DIR__ . '/../devtools.inc.php';
-require_once __DIR__ . '/../common_lib.inc';
-require_once __DIR__ . '/../breakdown.inc';
-require_once __DIR__ . '/../video/visualProgress.inc.php';
+require_once INCLUDES_PATH . '/include/FileHandler.php';
+require_once INCLUDES_PATH . '/devtools.inc.php';
+require_once INCLUDES_PATH . '/common_lib.inc';
+require_once INCLUDES_PATH . '/breakdown.inc';
+require_once INCLUDES_PATH . '/video/visualProgress.inc.php';
 
 class TestStepResult
 {

diff --git a/www/include/UserTimingHtmlTable.php b/www/include/UserTimingHtmlTable.php
@@ -4,7 +4,7 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/../common_lib.inc';
+require_once INCLUDES_PATH . '/common_lib.inc';
 
 class UserTimingHtmlTable
 {

diff --git a/www/include/WaterfallViewHtmlSnippet.php b/www/include/WaterfallViewHtmlSnippet.php
@@ -4,7 +4,7 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/../waterfall.inc';
+require_once INCLUDES_PATH . '/waterfall.inc';
 
 class WaterfallViewHtmlSnippet
 {

diff --git a/www/include/XmlResultGenerator.php b/www/include/XmlResultGenerator.php
@@ -4,11 +4,11 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 
-require_once __DIR__ . '/TestPaths.php';
-require_once __DIR__ . '/UrlGenerator.php';
+require_once INCLUDES_PATH . '/include/TestPaths.php';
+require_once INCLUDES_PATH . '/include/UrlGenerator.php';
 
 // TODO: get rid of this in the long run (for xml_entities)
-require_once __DIR__ . '/../common_lib.inc';
+require_once INCLUDES_PATH . '/common_lib.inc';
 
 class XmlResultGenerator
 {

diff --git a/www/include/social_meta.php b/www/include/social_meta.php
@@ -1,13 +1,11 @@
 <?php
 
-    require_once __DIR__ . '/../common_lib.inc';
-    require_once __DIR__ . '/../common.inc';
-    require_once __DIR__ . '/social_meta_vars.inc';
+require_once INCLUDES_PATH . '/include/social_meta_vars.inc';
 
-    global $socialImage;
-    global $socialTitle;
-    global $pageURI;
-    global $socialDesc;
+global $socialImage;
+global $socialTitle;
+global $pageURI;
+global $socialDesc;
 
 ?>
 

diff --git a/www/learn/lightning-fast-web-performance/certificate.php b/www/learn/lightning-fast-web-performance/certificate.php
@@ -5,7 +5,7 @@
     <?php
         require_once __DIR__ . '/../../common.inc';
         $useScreenshot = true;
-        require_once __DIR__ . '/../../head.inc';
+        require_once INCLUDES_PATH . '/head.inc';
     ?>
     <link rel="stylesheet" href="/learn/lightning-fast-web-performance/lfwp-assets/learn-course.css">
 </head>

diff --git a/www/learn/lightning-fast-web-performance/index.php b/www/learn/lightning-fast-web-performance/index.php
@@ -9,7 +9,7 @@
 
         $socialTitle = 'Lightning-Fast Web Performance Online Course from WebPageTest';
         $useScreenshot = true;
-        require_once __DIR__ . '/../../head.inc';
+        require_once INCLUDES_PATH . '/head.inc';
     ?>
     <link rel="stylesheet" href="/learn/lightning-fast-web-performance/lfwp-assets/learn-course.css">
 </head>
@@ -18,7 +18,7 @@
 
     <?php
      $tab = 'Resources';
-     require_once __DIR__ . '/../../templates/layouts/includes/wpt-header.php';
+     require_once WWW_PATH . '/templates/layouts/includes/wpt-header.php';
 
 
 
@@ -483,7 +483,7 @@
     </div>
     </div>
 
-    <?php require_once __DIR__ . '/../../footer.inc'; ?>
+    <?php require_once INCLUDES_PATH . '/footer.inc'; ?>
 
 </body>
 <script>

diff --git a/www/optimization.inc b/www/optimization.inc
@@ -3,7 +3,7 @@
 // Copyright 2020 Catchpoint Systems Inc.
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
-require_once __DIR__ . '/include/TestPaths.php';
+require_once INCLUDES_PATH . '/include/TestPaths.php';
 
 /**
  * Re-format the optimization report to make it prettier
@@ -53,7 +53,7 @@ function dumpOptimizationReportForStep($localPaths, &$pageData, &$requests, $tes
  */
 function ReportTTFB($localPaths, $pageData, $testinfoArray, $step)
 {
-    require_once __DIR__ . '/optimization_detail.inc.php';
+    require_once INCLUDES_PATH . '/optimization_detail.inc.php';
     $ttfb = (int) $pageData["TTFB"];
     $latency = isset($testinfoArray['latency']) ? $testinfoArray['latency'] : null;
     $score = gradeTTFBForStep($ttfb, $latency, $localPaths, $target);

diff --git a/www/optimizationChecklist.inc b/www/optimizationChecklist.inc
@@ -100,9 +100,9 @@ function drawChecklist($url, &$requests, &$pageData)
     imagestring($im, $font, $x, $y, $label, $black);
 
     // load the image icons (and size them)
-    $checkIcon = imagecreatefrompng(__DIR__ . '/assets/images/check.png');
-    $warningIcon = imagecreatefrompng(__DIR__ . '/assets/images/warning.png');
-    $errorIcon = imagecreatefrompng(__DIR__ . '/assets/images/error.png');
+    $checkIcon = imagecreatefrompng(ASSETS_PATH . '/images/check.png');
+    $warningIcon = imagecreatefrompng(ASSETS_PATH . '/images/warning.png');
+    $errorIcon = imagecreatefrompng(ASSETS_PATH . '/images/error.png');
 
     // draw the request information
     $i = 0;

diff --git a/www/optimizationChecklist.php b/www/optimizationChecklist.php
@@ -5,9 +5,9 @@
 // found in the LICENSE.md file.
 header("Content-type: image/png");
 include __DIR__ . '/common.inc';
-require_once __DIR__ . '/optimizationChecklist.inc';
-require_once __DIR__ . '/include/TestInfo.php';
-require_once __DIR__ . '/include/TestStepResult.php';
+require_once INCLUDES_PATH . '/optimizationChecklist.inc';
+require_once INCLUDES_PATH . '/include/TestInfo.php';
+require_once INCLUDES_PATH . '/include/TestStepResult.php';
 
 // not functional, but to declare what to expect from common.inc
 global $testPath, $run, $cached, $step, $id, $url, $test;

diff --git a/www/page_data.inc b/www/page_data.inc
@@ -3,9 +3,9 @@
 // Copyright 2020 Catchpoint Systems Inc.
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
-require_once(__DIR__ . '/devtools.inc.php');
-require_once(__DIR__ . '/include/TestPaths.php');
-require_once(__DIR__ . '/video/visualProgress.inc.php');
+require_once(INCLUDES_PATH . '/devtools.inc.php');
+require_once(INCLUDES_PATH . '/include/TestPaths.php');
+require_once(INCLUDES_PATH . '/video/visualProgress.inc.php');
 
 /**
 * Load the page results directly from the results files
@@ -1425,7 +1425,7 @@ function CalculateTimeToInteractive($localPaths, $startTime, $interactiveWindows
     $rw = array();
     if (count($iw)) {
       // Find all of the request windows with 5 seconds of no more than 2 concurrent document requests
-        require_once(__DIR__ . '/object_detail.inc');
+        require_once(INCLUDES_PATH . '/object_detail.inc');
         $requests = getRequestsForStep($localPaths, null, $has_secure_requests);
         if (isset($requests) && is_array($requests) && count($requests)) {
           // Build a list of start/end events for document requests

diff --git a/www/pageimages.php b/www/pageimages.php
@@ -4,12 +4,12 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 include __DIR__ . '/common.inc';
-require_once __DIR__ . '/object_detail.inc';
-require_once __DIR__ . '/page_data.inc';
-require_once __DIR__ . '/include/TestInfo.php';
-require_once __DIR__ . '/include/TestPaths.php';
-require_once __DIR__ . '/include/TestStepResult.php';
-require_once __DIR__ . '/include/UrlGenerator.php';
+require_once INCLUDES_PATH . '/object_detail.inc';
+require_once INCLUDES_PATH . '/page_data.inc';
+require_once INCLUDES_PATH . '/include/TestInfo.php';
+require_once INCLUDES_PATH . '/include/TestPaths.php';
+require_once INCLUDES_PATH . '/include/TestStepResult.php';
+require_once INCLUDES_PATH . '/include/UrlGenerator.php';
 
 global $testPath, $id, $run, $cached, $step; // defined in common.inc
 

diff --git a/www/performance_optimization.php b/www/performance_optimization.php
@@ -4,11 +4,11 @@
 // Use of this source code is governed by the Polyform Shield 1.0.0 license that can be
 // found in the LICENSE.md file.
 include __DIR__ . '/common.inc';
-require_once __DIR__ . '/include/TestInfo.php';
-require_once __DIR__ . '/include/TestRunResults.php';
-require_once __DIR__ . '/optimization_detail.inc.php';
-require_once __DIR__ . '/include/PerformanceOptimizationHtmlSnippet.php';
-require_once __DIR__ . '/include/AccordionHtmlHelper.php';
+require_once INCLUDES_PATH . '/include/TestInfo.php';
+require_once INCLUDES_PATH . '/include/TestRunResults.php';
+require_once INCLUDES_PATH . '/optimization_detail.inc.php';
+require_once INCLUDES_PATH . '/include/PerformanceOptimizationHtmlSnippet.php';
+require_once INCLUDES_PATH . '/include/AccordionHtmlHelper.php';
 
 $page_keywords = array('Optimization','WebPageTest','Website Speed Test','Page Speed');
 $page_description = "Website performance optimization recommendations$testLabel.";
@@ -124,7 +124,6 @@
 
             <h3 class="hed_sub">Glossary</h3>
             <?php
-                require_once __DIR__ . '/resources/view.php';
                 echo view('partials.glossary', []);
             ?>
 

diff --git a/www/resources/views/pages/testhistory.blade.php b/www/resources/views/pages/testhistory.blade.php
@@ -74,10 +74,10 @@
 <script>
     <?php
     if ($is_logged_in) {
-        include __DIR__ . '/../../js/history-loggedin.js';
+        include ASSETS_PATH . '/js/history-loggedin.js';
     } else {
         // if not logged in, build a local searchable test history from the data stored in indexeddb.
-        include __DIR__ . '/../../js/history.js';
+        include ASSETS_PATH . '/js/history.js';
     }
     ?>
 </script>