chore: use common function for backend http requests

mcdurdin · mcdurdin · commit 0b9e537b8436 · 2026-06-12T11:53:16.000+02:00
Establish Util::call_api_keyman_com and Util::call_downloads_keyman_com
as common functions for making http requests to these servers. Use curl
instead of file_get_contents as it is more reliable and we have more
control over parameters.

Test-bot: skip
diff --git a/_content/developer/keymanweb/keyboards.php b/_content/developer/keymanweb/keyboards.php
@@ -2,6 +2,7 @@
   require_once _KEYMANCOM_INCLUDES . '/includes/template.php';
   require_once _KEYMANCOM_INCLUDES . '/autoload.php';
   use Keyman\Site\Common\KeymanHosts;
+  use Keyman\Site\com\keyman\Util;
 
   // Required
   head([
@@ -110,7 +111,7 @@
   <tbody>
 
 <?php
-  $data = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com . '/cloud/4.0/keyboards?languageidtype=bcp47&version='.$stable_version);
+  $data = Util::call_api_keyman_com('/cloud/4.0/keyboards?languageidtype=bcp47&version='.$stable_version);
   if($data === FALSE) {
     // fallback if API is down, bad news anyway.
     $data = file_get_contents('keyboards.txt');
diff --git a/_content/developer/keymanweb/keymanweb-version.inc.php b/_content/developer/keymanweb/keymanweb-version.inc.php
@@ -2,10 +2,11 @@
 require_once _KEYMANCOM_INCLUDES . '/includes/servervars.php';
 
 use Keyman\Site\Common\KeymanHosts;
+use Keyman\Site\com\keyman\Util;
 
 function getKeymanWebHref()
 {
-  $json = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com . "/version/web");
+  $json = Util::call_api_keyman_com("/version/web");
   if ($json) {
     $json = json_decode($json);
   }
diff --git a/_content/downloads/all-versions/index.php b/_content/downloads/all-versions/index.php
@@ -2,6 +2,7 @@
 require_once _KEYMANCOM_INCLUDES . '/includes/template.php';
 require_once _KEYMANCOM_INCLUDES . '/includes/ui/downloads.php';
 use Keyman\Site\Common\KeymanHosts;
+use Keyman\Site\com\keyman\Util;
 
 // Required
 head([
@@ -14,7 +15,7 @@
 <h2 class="red underline large">Keyman downloads - all versions</h2>
 
 <?php
-$data = json_decode(file_get_contents(KeymanHosts::Instance()->SERVER_downloads_keyman_com . '/api/version/all'));
+$data = @json_decode(Util::call_downloads_keyman_com('/api/version/all'));
 
 if ($data === NULL) {
   die('Error decoding JSON data.');
diff --git a/_content/downloads/releases/_version_downloads.php b/_content/downloads/releases/_version_downloads.php
@@ -5,6 +5,7 @@
   require_once _KEYMANCOM_INCLUDES . '/includes/playstore.php';
   use Keyman\Site\Common\KeymanHosts;
   use Keyman\Site\com\keyman\Locale;
+  use Keyman\Site\com\keyman\Util;
 
   Locale::definePageScope('LOCALE_DOWNLOADS', 'downloads');
 
@@ -31,8 +32,7 @@ function array_key_first(array $arr) {
   }
 
   // note: we currently ignore the tier parameter
-
-  $versions = @json_decode(file_get_contents(KeymanHosts::Instance()->SERVER_downloads_keyman_com . "/api/version/2.0?targetVersion=$version"));
+  $versions = @json_decode(Util::call_downloads_keyman_com("/api/version/2.0?targetVersion=$version"));
 
   if(empty($versions->android))
     $tier = 'unknown';
@@ -47,8 +47,7 @@ function array_key_first(array $arr) {
   $versionTier = $version . ($tier == 'stable' ? "" : "-$tier");
 
 
-
-  $versionsData = @json_decode(file_get_contents(KeymanHosts::Instance()->SERVER_downloads_keyman_com . "/api/version/all"));
+  $versionsData = @json_decode(Util::call_downloads_keyman_com("/api/version/all"));
   if (!$versionsData) {
     die("Failed to retrieve or parse the API data.");
   }
diff --git a/_content/keyboards/install.php b/_content/keyboards/install.php
@@ -375,7 +375,7 @@ protected static function LoadData() {
 
       // Get Keyboard Metadata
 
-      $s = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com . '/keyboard/' . rawurlencode(self::$id));
+      $s = Util::call_api_keyman_com('/keyboard/' . rawurlencode(self::$id));
       if ($s === FALSE) {
         // Will fail later in the script
         self::$error .= error_get_last()['message'] . "\n";
@@ -396,7 +396,7 @@ protected static function LoadData() {
 
       // Get Program Download Versions and URLs
 
-      $s = @file_get_contents(KeymanHosts::Instance()->SERVER_downloads_keyman_com . '/api/version/1.0');
+      $s = Util::call_downloads_keyman_com('/api/version/1.0');
       if ($s === FALSE) {
         // Will fail later in the script
         self::$error .= error_get_last()['message'] . "\n";
diff --git a/_content/keyboards/keyboard.json.php b/_content/keyboards/keyboard.json.php
@@ -2,6 +2,7 @@
   require_once _KEYMANCOM_INCLUDES . '/includes/servervars.php';
   require_once _KEYMANCOM_INCLUDES . '/autoload.php';
   use Keyman\Site\Common\KeymanHosts;
+  use Keyman\Site\com\keyman\Util;
 
   if(!isset($_REQUEST['id'])) {
     header('HTTP/1.0 404 id parameter is required');
@@ -14,7 +15,7 @@
   header('Content-Type: application/json; charset=utf-8');
   header('Access-Control-Allow-Origin: *');
 
-  $kmw = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com . "/cloud/4.0/keyboards/$id?version=$version&languageidtype=bcp47");
+  $kmw = Util::call_api_keyman_com("/cloud/4.0/keyboards/$id?version=$version&languageidtype=bcp47");
   if($kmw === FALSE) {
     header('HTTP/1.0 404 Keyboard not found');
     exit;
diff --git a/_content/keyboards/keyboard.php b/_content/keyboards/keyboard.php
@@ -4,6 +4,7 @@
   require_once('./session.php');
   require_once _KEYMANCOM_INCLUDES . '/autoload.php';
   use Keyman\Site\Common\KeymanHosts;
+  use Keyman\Site\com\keyman\Util;
 
   if(isset($_REQUEST['legacy'])) {
     $id = find_id_by_legacy(clean_id($_REQUEST['legacy']));
@@ -27,7 +28,7 @@ function clean_id($id) {
   }
 
   function find_id_by_legacy($legacy) {
-    $s = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com.'/search/?q=k:legacy:'.rawurlencode($legacy));
+    $s = Util::call_api_keyman_com('/search/?q=k:legacy:'.rawurlencode($legacy));
     if($s === FALSE) {
       return null;
     }
diff --git a/_content/keyboards/share.php b/_content/keyboards/share.php
@@ -5,6 +5,7 @@
   require_once _KEYMANCOM_INCLUDES . '/autoload.php';
   use Keyman\Site\Common\KeymanHosts;
   use Keyman\Site\com\keyman\Locale;
+  use Keyman\Site\com\keyman\Util;
 
   Locale::definePageScope('LOCALE_KEYBOARDS_SHARE', 'keyboards/share');
 
@@ -24,7 +25,7 @@ function clean_id($id) {
   }
 
   function find_keyboard($id) {
-    $s = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com.'/keyboard/'.$id);
+    $s = Util::call_api_keyman_com('/keyboard/'.$id);
     if($s === FALSE) {
       return null;
     }
diff --git a/_includes/2020/KeymanDownloadVersions.php b/_includes/2020/KeymanDownloadVersions.php
@@ -4,6 +4,7 @@
   namespace Keyman\Site\com\keyman;
 
   use Keyman\Site\Common\KeymanHosts;
+  use Keyman\Site\com\keyman\Util;
 
   class KeymanDownloadVersions {
     private static $versions;
@@ -18,7 +19,7 @@ class KeymanDownloadVersions {
 
     static function getDownloadUrls() {
       if(empty(self::$versions))
-        self::$versions = @json_decode(file_get_contents(KeymanHosts::Instance()->SERVER_downloads_keyman_com . '/api/version/2.0'));
+        self::$versions = @json_decode(Util::call_downloads_keyman_com('/api/version/2.0'));
       return self::$versions;
     }
 
diff --git a/_includes/2020/KeymanWebHost.php b/_includes/2020/KeymanWebHost.php
@@ -4,10 +4,11 @@
 
 namespace Keyman\Site\com\keyman;
 use Keyman\Site\Common\KeymanHosts;
+use Keyman\Site\com\keyman\Util;
 
 class KeymanWebHost {
   static function getKeymanWebUrlBase() {
-    $json = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com."/version/web");
+    $json = Util::call_api_keyman_com("/version/web");
     if($json) {
       $json = json_decode($json);
     }
diff --git a/_includes/2020/Util.php b/_includes/2020/Util.php
@@ -21,8 +21,8 @@ static function cdn($file) {
           $cdn = false;
         }
       }
-      $use_cdn = KeymanHosts::Instance()->Tier() == KeymanHosts::TIER_PRODUCTION || 
-          KeymanHosts::Instance()->Tier() == KeymanHosts::TIER_STAGING || 
+      $use_cdn = KeymanHosts::Instance()->Tier() == KeymanHosts::TIER_PRODUCTION ||
+          KeymanHosts::Instance()->Tier() == KeymanHosts::TIER_STAGING ||
           (isset($_REQUEST['cdn']) && $_REQUEST['cdn'] == 'force');
       if($use_cdn) {
         if($cdn && isset($cdn['/'.$file])) {
@@ -32,4 +32,31 @@ static function cdn($file) {
       // TODO: log warning or error to sentry on missing files
       return "/cdn/dev/{$file}";
     }
+
+    static function call_api_keyman_com($url) {
+      return Util::call_keyman_site(KeymanHosts::Instance()->SERVER_api_keyman_com, $url);
+    }
+
+    static function call_keyman_site($site, $url) {
+      // curl library is more reliable than file_get_contents
+      $curl_handle=curl_init();
+      curl_setopt($curl_handle, CURLOPT_URL, $site . $url);
+      curl_setopt($curl_handle, CURLOPT_CONNECTTIMEOUT, 2);
+      curl_setopt($curl_handle, CURLOPT_RETURNTRANSFER, 1);
+      curl_setopt($curl_handle, CURLOPT_USERAGENT, 'keyman.com/1.0');
+      $query = @curl_exec($curl_handle);
+      $http_code = curl_getinfo($curl_handle, CURLINFO_HTTP_CODE);
+      curl_close($curl_handle);
+      if($http_code >= 200 && $http_code <= 299) {
+        return $query;
+      } else {
+        @trigger_error("request to $site$url failed with $http_code");
+        return FALSE;
+      }
+    }
+
+    static function call_downloads_keyman_com($url) {
+      return Util::call_keyman_site(KeymanHosts::Instance()->SERVER_downloads_keyman_com, $url);
+    }
+
   }
diff --git a/_includes/2020/templates/Head.php b/_includes/2020/templates/Head.php
@@ -68,6 +68,10 @@ static function render($fields = []) {
       echo "<script id='i18n_$domain' type='application/json'>[\n$localization\n]</script>\n";
     }
 
+    echo "<script>\n";
+    KeymanHosts::Instance()->emitJavascriptConst();
+    echo "\n  window.keymanHosts = keymanHosts;\n</script>";
+
     array_unshift($fields->js,
       Util::cdn('js/jquery1-11-1.min.js'),
       Util::cdn('js/bowser.es5.2.9.0.min.js'),
diff --git a/_includes/includes/ui/downloads.php b/_includes/includes/ui/downloads.php
@@ -3,12 +3,10 @@
   require_once _KEYMANCOM_INCLUDES . '/autoload.php';
   use Keyman\Site\Common\KeymanHosts;
   use Keyman\Site\com\keyman\Locale;
+  use Keyman\Site\com\keyman\Util;
   Locale::definePageScope('LOCALE_DOWNLOADS', 'downloads');
 
-  $versions = @json_decode(file_get_contents(KeymanHosts::Instance()->SERVER_downloads_keyman_com . '/api/version/2.0'));
-  //if($versions === NULL || $versions === FALSE) {
-  //  echo "<p class='error'>WARNING: unable to retrieve latest versions of Keyman from download server</p>";
-  //}
+  $versions = @json_decode(Util::call_downloads_keyman_com('/api/version/2.0'));
 
   function formatSizeUnits($bytes) {
     if ($bytes >= 1073741824) {
diff --git a/_includes/includes/ui/keyboard-details.php b/_includes/includes/ui/keyboard-details.php
@@ -10,6 +10,7 @@
   use \Keyman\Site\com\keyman\KeymanWebHost;
   use \Keyman\Site\Common\KeymanHosts;
   use \Keyman\Site\com\keyman\Locale;
+  use \Keyman\Site\com\keyman\Util;
   use \Keyman\Site\com\keyman;
 
   Locale::definePageScope('LOCALE_KEYBOARDS_DETAILS', 'keyboards/details');
@@ -192,10 +193,10 @@ protected static function LoadData() {
       global $_m_Keyboards_Details;
 
       self::$error = "";
-      $s = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com. '/keyboard/' . rawurlencode(self::$id));
+      $s = Util::call_api_keyman_com('/keyboard/' . rawurlencode(self::$id));
       if ($s === FALSE) {
         // Will fail later in the script
-        self::$error .= error_get_last()['message'] . "\n";
+        self::$error .= "The keyboard was not found in the database\n"; //error_get_last()['message'] . "\n";
         self::$title = $_m_Keyboards_Details("failed_to_load_keyboard_package", self::$id);
         header('HTTP/1.0 404 Keyboard not found');
       } else {
@@ -255,7 +256,7 @@ protected static function LoadData() {
 
         self::$downloadCount = 0;
         self::$totalDownloadCount = 0;
-        $s = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com.'/search/2.0?q=k:id:' . rawurlencode(self::$id));
+        $s = Util::call_api_keyman_com('/search/2.0?q=k:id:' . rawurlencode(self::$id));
         if ($s !== FALSE) {
           $s = json_decode($s);
           if(is_object($s) && is_array(($s->keyboards))) {
@@ -629,7 +630,7 @@ protected static function WriteKeyboardDetails() {
                     // TODO(lowpri): we could return this information in the API to avoid multiple
                     // round trip queries but that requires more changes to the API, docs, and
                     // schema.
-                    $s = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com.'/keyboard/' . rawurlencode($name));
+                    $s = Util::call_api_keyman_com('/keyboard/' . rawurlencode($name));
                     if ($s === FALSE) {
                       echo "<span class='keyboard-unavailable' title='" .
                         $_m_Keyboards_Details("keyboard_not_available",
diff --git a/cdn/dev/keyboard-search/search.mjs b/cdn/dev/keyboard-search/search.mjs
@@ -100,7 +100,7 @@ function wrapSearch(localCounter, updateHistory) {
     return false;
   }
 
-  var base = location.protocol+'//api.'+location.host; // this works on test sites as well as live, assuming we use the host pattern "keyman.com[.localhost]"
+  var base = window.keymanHosts.api;
   var url = base+'/search/2.0?p='+page+'&q='+encodeURIComponent(stripCommonWords(q));
 
   if(window.embed) {
diff --git a/go/download/_download.php b/go/download/_download.php
@@ -27,7 +27,7 @@
     $WINDOWS_VERSION = $_REQUEST['version'];
     $MAC_VERSION = $_REQUEST['version'];
   } else {
-    $versions = @json_decode(file_get_contents(KeymanHosts::Instance()->SERVER_downloads_keyman_com . '/api/version/2.0'));
+    $versions = @json_decode(Util::call_downloads_keyman_com('/api/version/2.0'));
 
     $DEVELOPER_VERSION = $versions->developer->$TIER->version;
     $WINDOWS_VERSION = $versions->windows->$TIER->version;
diff --git a/go/package/download.php b/go/package/download.php
@@ -8,6 +8,7 @@
   const DEBUG=0;
 
   use Keyman\Site\com\keyman\KeymanComSentry;
+  use Keyman\Site\com\keyman\Util;
   use Keyman\Site\com\keyman\Validation;
   use Keyman\Site\Common\KeymanHosts;
   use Keyman\Site\Common\JsonApiFailure;
@@ -42,7 +43,7 @@ public static function redirect_to_file($type, $id, $version, $platform, $tier,
 
       if(empty($version)) {
         // If version isn't provided, we'll query the live api for the version
-        $json = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com . "/$type/" . rawurlencode($id));
+        $json = Util::call_api_keyman_com("/$type/" . rawurlencode($id));
         if ($json !== FALSE) {
           $json = json_decode($json);
         }

Original file line number	Diff line number	Diff line change
`@@ -2,10 +2,11 @@`
`2`	`2`	`require_once _KEYMANCOM_INCLUDES . '/includes/servervars.php';`
`3`	`3`
`4`	`4`	`use Keyman\Site\Common\KeymanHosts;`
	`5`	`+use Keyman\Site\com\keyman\Util;`
`5`	`6`
`6`	`7`	`function getKeymanWebHref()`
`7`	`8`	`{`
`8`		`- $json = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com . "/version/web");`
	`9`	`+ $json = Util::call_api_keyman_com("/version/web");`
`9`	`10`	`if ($json) {`
`10`	`11`	`$json = json_decode($json);`
`11`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`require_once('./session.php');`
`5`	`5`	`require_once _KEYMANCOM_INCLUDES . '/autoload.php';`
`6`	`6`	`use Keyman\Site\Common\KeymanHosts;`
	`7`	`+ use Keyman\Site\com\keyman\Util;`
`7`	`8`
`8`	`9`	`if(isset($_REQUEST['legacy'])) {`
`9`	`10`	`$id = find_id_by_legacy(clean_id($_REQUEST['legacy']));`
`@@ -27,7 +28,7 @@ function clean_id($id) {`
`27`	`28`	`}`
`28`	`29`
`29`	`30`	`function find_id_by_legacy($legacy) {`
`30`		`- $s = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com.'/search/?q=k:legacy:'.rawurlencode($legacy));`
	`31`	`+ $s = Util::call_api_keyman_com('/search/?q=k:legacy:'.rawurlencode($legacy));`
`31`	`32`	`if($s === FALSE) {`
`32`	`33`	`return null;`
`33`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`require_once _KEYMANCOM_INCLUDES . '/autoload.php';`
`6`	`6`	`use Keyman\Site\Common\KeymanHosts;`
`7`	`7`	`use Keyman\Site\com\keyman\Locale;`
	`8`	`+ use Keyman\Site\com\keyman\Util;`
`8`	`9`
`9`	`10`	`Locale::definePageScope('LOCALE_KEYBOARDS_SHARE', 'keyboards/share');`
`10`	`11`
`@@ -24,7 +25,7 @@ function clean_id($id) {`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`function find_keyboard($id) {`
`27`		`- $s = @file_get_contents(KeymanHosts::Instance()->SERVER_api_keyman_com.'/keyboard/'.$id);`
	`28`	`+ $s = Util::call_api_keyman_com('/keyboard/'.$id);`
`28`	`29`	`if($s === FALSE) {`
`29`	`30`	`return null;`
`30`	`31`	`}`