Merge pull request #629 from keymanapp/auto/A19S17-merge-master-into-staging

auto: A19S17 merge master into staging

Author: keyman-status

.github/workflows/ci.yml

@@ -11,33 +11,47 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3.5.2
+      uses: actions/checkout@v4.1.5
 
     - name: Build the docker image for keyman.com app
       shell: bash
       run: |
         echo "TIER_TEST" > tier.txt
-        ./build.sh build start
+        ./build.sh configure build start --debug
       env:
         fail-fast: true
 
     #
     # Finally, run the tests
     #
+    - name: PHP test
+      shell: bash
+      run: |
+        docker exec keyman-com-app sh -c "vendor/bin/phpunit --testdox"
+
     - name: Lint
       shell: bash
       run: |
         ( set +e; set +o pipefail; find . -name '*.php' | grep -v '/vendor/' | xargs -n 1 -d '\n' php -l | grep -v "No syntax errors detected"; exit ${PIPESTATUS[2]} )
 
     - name: Check broken links
       shell: bash
+      continue-on-error: false
+      # Exclude checking locales for each link 'lang=*'
+      run: |
+        set +e
+        set +o pipefail
+        npx broken-link-checker http://localhost:8053/_test --recursive --ordered ---host-requests 50 -e --filter-level 3 --exclude '*/donate' --exclude '*lang=*' | tee blc.log
+        echo "BLC_RESULT=${PIPESTATUS[0]}" >> "$GITHUB_ENV"
+
+    - name: Report on broken links
       run: |
-        set +e;
-        set +o pipefail;
-        npx broken-link-checker http://localhost:8053/_test --ordered --recursive --host-requests 50 -e --filter-level 3 --exclude '*/donate' | \
+        set +e
+        set +o pipefail
+        cat blc.log | \
           grep -E "BROKEN|Getting links from" | \
-          grep -B 1 "BROKEN"
-        exit ${PIPESTATUS[0]}
+          grep -B 1 "BROKEN";
+        exit "${BLC_RESULT}"
 
     - name: Check PHP errors
       shell: bash

.gitignore

@@ -4,6 +4,10 @@ cdn/deploy/
 
 tier.txt
 
+# unit test artifacts
+blc.log
+.phpunit.result.cache
+
 vendor*
 /node_modules/
 

.htaccess

@@ -34,6 +34,9 @@ RewriteRule "^(macosx|macos)\b(.*)$" "/mac$2" [NC,R=301,END,QSA]
 # Redirect deprecated Google Plus link
 RewriteRule "^plus.*" "/" [NC,R=301,END,QSA]
 
+# Redirect PHP unit tests
+RewriteRule "^tests(\/.*)?" "/" [NC,R=301,END,QSA]
+
 # /donate -> donate.keyman.com
 RedirectMatch 301 "^(?i)/donate(\/.*)?" "https://donate.keyman.com"
 
@@ -93,7 +96,7 @@ RewriteRule "^keyboards/download/([^/]+)$" "/keyboards/keyboard.php?id=$1" [END,
 
 # /keyboards/share/[id] to /keyboards/share.php
 # if the keyboard exists in the repo, then share.php will redirect to /keyboards/<id>
-RewriteRule "^keyboards/share/([^/]+)$" "/keyboards/share.php?id=$1" [END]
+RewriteRule "^keyboards/share/([^/]+)$" "/keyboards/share.php?id=$1" [END,QSA]
 
 # /keyboards/{id}.json to /keyboards/keyboard.json.php
 RewriteRule "^keyboards/(?!keyboard.json)(.*)\.json$" "/keyboards/keyboard.json.php?id=$1" [END]

Dockerfile

@@ -1,4 +1,6 @@
 # syntax=docker/dockerfile:1
+
+ARG BUILDER_CONFIGURATION="release"
 FROM php:7.4-apache@sha256:c9d7e608f73832673479770d66aacc8100011ec751d1905ff63fae3fe2e0ca6d AS composer-builder
 
 # Install Zip to use composer
@@ -15,7 +17,14 @@ RUN composer self-update
 USER www-data
 WORKDIR /composer
 COPY composer.* /composer/
-RUN composer install
+# Consume the build argment
+ARG BUILDER_CONFIGURATION
+RUN if [ "$BUILDER_CONFIGURATION" = "debug" ]; then \
+      # composer install --dev deprecated
+      COMPOSER_NO_DEV=0 composer install ; \
+    else \
+      COMPOSER_NO_DEV=1 composer install ; \
+    fi
 
 # Site
 FROM php:7.4-apache@sha256:c9d7e608f73832673479770d66aacc8100011ec751d1905ff63fae3fe2e0ca6d

README.md

@@ -52,6 +52,12 @@ shell, and from this folder, run:
 ./build.sh build
 ```
 
+If you'll be running tests locally, the Docker image will need to be built with dev dependencies:
+
+```sh
+./build.sh build --debug
+```
+
 #### Start the Docker container
 
 To start up the website, in bash, run:
@@ -81,7 +87,11 @@ In bash, run:
 
 #### Running tests
 
-To check for broken links and .php file conformance, when the site is running,
+When the site is running, the test action will do the following:
+* PHP unit tests
+* Check .php file conformance
+* Check for internal broken links
+
 in bash, run:
 
 ```sh

_includes/2020/templates/Foot.php

@@ -38,6 +38,7 @@ static function render(array $fields = []) {
             </div>
             <!--End mc_embed_signup-->
             <br>
+            <div id="low-frequency">Receive updates 3-4 times/year, or you can<br><a href="https://blog.keyman.com/subscribe/">get regular updates</a> every 2 weeks</div>
             <div id="privacy-policy"><a href="/privacy/">Privacy policy</a></div>
 
             <div id='footer-get-involved'>

_includes/2020/templates/Menu.php

@@ -29,6 +29,63 @@ public static function render(array $fields): void {
       Menu::render_top_menu($fields);
     }
 
+    /**
+     * Generate the URL with query to change the UI language
+     * @param language - language tag to use
+     */
+    private static function change_ui_language($language): string {
+      // Parse the current URI for populating the UI dropdown
+      $url = isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '/';
+      $parts = parse_url($url);
+
+      if (!empty($parts['query'])) {
+        parse_str($parts['query'], $queryParams);
+      } else {
+        $queryParams = [];
+      }
+
+      // Set the language query
+      $queryParams['lang'] = $language;
+      $query = http_build_query($queryParams);
+
+      return $parts['path'] . "?" . $query;
+    }
+
+    /**
+     * Render the globe dropdown for changing the UI language
+     * As UI languages get added, we'll need to update this.
+     * Limitation: Currently only visible on pages that use localized strings
+     * @param number - Div number, default 0.
+     */
+    private static function render_globe_dropdown($number = 0): void {
+      global $page_is_using_locale;
+      if (!isset($page_is_using_locale) || !$page_is_using_locale) {
+        // only render on pages that use localized strings
+        return;
+      }
+
+      $divID = ($number == 1) ? "ui-language1" : "ui-language";
+echo <<<END
+          <p>
+            <div id='$divID' class="menu-item">
+END;
+?>
+              <img src="<?php echo Util::cdn("img/globe.png"); ?>" alt="UI globe dropdown" />
+              <div class="menu-item-dropdown">
+                <div class="menu-dropdown-inner">
+                  <ul>
+                    <!-- Just use autonyms -->
+                    <li><a href="<?= Menu::change_ui_language('en'); ?>">English</a></li>
+                    <li><a href="<?= Menu::change_ui_language('es'); ?>">Español</a></li>
+                    <li><a href="<?= Menu::change_ui_language('fr'); ?>">Français</a></li>
+                  </ul>
+                </div>
+              </div>
+            </div>
+          </p>
+<?php
+    }
+
     private static function render_phone_menu(object $fields): void {
 ?>
 
@@ -117,6 +174,9 @@ private static function render_top_menu(object $fields): void {
           </form>
           <p id="donate"><a href="/donate">Donate</a></p>
           <p><a href="<?= KeymanHosts::Instance()->help_keyman_com ?>" target="blank">Support<img src="<?php echo Util::cdn("img/helpIcon.png"); ?>" alt="help icon"></a></p>
+          <?php
+            Menu::render_globe_dropdown();
+?>
         </div>
     </div>
     <div id="top-menu-bg"></div>
@@ -132,6 +192,9 @@ private static function render_top_menu(object $fields): void {
           </form>
           <a id='help1-donate' href="/donate">Donate</a>
           <a href="<?= KeymanHosts::Instance()->help_keyman_com ?>"><img id="top-menu-icon2" src="<?php echo Util::cdn("img/helpIcon.png"); ?>" alt="help icon" /></a>
+<?php
+            Menu::render_globe_dropdown(1);
+?>
         </div>
         <div class="wrapper">
             <div class="menu-item" id="keyboards">

_includes/autoload.php

@@ -5,7 +5,11 @@
     if(preg_match('/^Keyman\\\\Site\\\\com\\\\keyman\\\\(.+)/', $class_name, $matches)) {
       // Fix namespace pathing for Linux
       $filename = str_replace(array('\\', '/'), DIRECTORY_SEPARATOR, $matches[1]);
-      $success = include(__DIR__ . "/2020/{$filename}.php");
+      if ($filename == 'Locale') {
+        $success = include(__DIR__ . "/locale/{$filename}.php");
+      } else {
+        $success = include(__DIR__ . "/2020/{$filename}.php");
+      }
       if($success === FALSE) {
         debug_print_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
         die("Unable to find class $class_name");

_includes/includes/template.php

@@ -3,9 +3,12 @@
 
   // *Don't* use autoloader here because of potential side-effects in older pages
   require_once(__DIR__ . '/../2020/Util.php');
+  require_once(__DIR__ . '/../locale/Locale.php');
   require_once(__DIR__ . '/../../_common/KeymanVersion.php');
   require_once(__DIR__ . '/../2020/templates/Head.php');
 
+  use Keyman\Site\com\keyman\Locale;
+  
   function template_finish($foot) {
     //ob_end_flush();