mainly compatibility fixes and cosmetics

fabianswebworld · web-flow · commit 6ad06a7fd2ed · 2023-08-11T13:23:57.000+02:00
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,11 @@
+1.4.1.661
+
+- JS fix: fix for possible errorneous leading zero before year number in custom header
+- JS fix: Some browser compatibility fixes in ttxweb.js
+- Some more browser compatibility improvements
+- Added seqn0 URL parameter to control display of subpage sequence number (debug use)
+- Clearer comments in code and documentation regarding turn rates
+
 1.4.0.660
 
 - New: file name pattern for EP1 files is now configurable via ttxweb_config.php
diff --git a/README.md b/README.md
@@ -110,8 +110,8 @@ The following URL parameters are supported (if provided, they override the value
 - **refresh** - seconds for auto refresh via XHR, 0 = disabled (default: set by TTXWEB_REFRESH in ttxweb_config.php)
 - **template** - override configured template name (default: set by TTXWEB_TEMPLATE in ttxweb_config.php)
 - **turn** - 0 (do not automatically turn subpages) | 1 (turn subpage on every XHR refresh) | *not set* (turn according to TTXWEB_TURN_RATES in ttxweb_config.php, **default**)
-
-The **xhr** GET parameter is used internally to implement the XMLHttpRequest refresh function. By setting it to 1 you can get only the ttxContainer part of the page if you want to embed it in your own XMLHttpRequest applications.
+- **seqn0** - 0 (display actual subpage number in header) | 1 (display subpage number in header as *00*; useful for "animated" pages that otherwise have no multi-page content and would be transmitted with 0000 instead of SEQN in linear transmission) | *not set* (show subpage number as 00 only for pages defined in TTXWEB_TURN_RATES)
+- **xhr** - this parameter is used internally to implement the XMLHttpRequest refresh function. By setting it to 1 you can get only the ttxStage part of the page if you want to embed it in your own XMLHttpRequest applications.
 
 # Contact the author
 
diff --git a/includes/ttxweb_decoder.php b/includes/ttxweb_decoder.php
@@ -1,7 +1,7 @@
 <?php
 
 // ttxweb.php EP1 teletext document renderer
-// version: 1.4.0.660 (2023-08-10)
+// version: 1.4.1.661 (2023-08-11)
 // (c) 2023 Fabian Schneider - @fabianswebworld
 
 const EP1_HEADER_LENGTH = 6;
@@ -552,20 +552,20 @@ function g0ToHtml($ttxString, $ttxLanguage) {
         case 'de-DE':
             return str_replace(
                 ['&', chr(0x24), '@', '[', '\\', ']', '`', '{', '|', '}', '~', chr(0x7f), '<', '>', '"', '\''],
-                ['&amp;', '$', '&sect;', '&Auml;', '&Ouml;', '&Uuml;', '&deg;', '&auml;', '&ouml;', '&uuml;', '&szlig;', '&#9632;', '&lt;', '&gt;', '&quot;', '&apos;'],
+                ['&amp;', '$', '&sect;', '&Auml;', '&Ouml;', '&Uuml;', '&deg;', '&auml;', '&ouml;', '&uuml;', '&szlig;', '&#9632;', '&lt;', '&gt;', '&quot;', '&#39;'],
                 $ttxString
             );
             break;
         case 'en-GB':
             return str_replace(
                 ['&', chr(0x23), chr(0x24), '@', '[', '\\', ']', chr(0x5e), chr(0x5f), '`', '{', '|', '}', '~', chr(0x7f), '<', '>', '"', '\''],
-                ['&amp;', '&pound;', '$', '@', '&#8592;', '&frac12;', '&#8594;', '&#8593;', '#', '&#8212;', '&frac14;', '&#9553;', '&frac34;', '&divide;', '&#9632;', '&lt;', '&gt;', '&quot;', '&apos;', '&amp;'],
+                ['&amp;', '&pound;', '$', '@', '&#8592;', '&frac12;', '&#8594;', '&#8593;', '#', '&#8212;', '&frac14;', '&#9553;', '&frac34;', '&divide;', '&#9632;', '&lt;', '&gt;', '&quot;', '&#39;', '&amp;'],
                 $ttxString
             );
         default:
             return str_replace(
                 ['&', chr(0x7f), '<', '>', '"', '\''],
-                ['&amp;', '&#9632;', '&lt;', '&gt;', '&quot;', '&apos;'],
+                ['&amp;', '&#9632;', '&lt;', '&gt;', '&quot;', '&#39;'],
                 $ttxString
             );
     }
diff --git a/includes/ttxweb_main.php b/includes/ttxweb_main.php
@@ -1,12 +1,12 @@
 <?php
 
 // ttxweb.php EP1 teletext document renderer
-// version: 1.4.0.660 (2023-08-10)
+// version: 1.4.1.661 (2023-08-11)
 // (c) 2023 Fabian Schneider - @fabianswebworld
 
 // GLOBAL DEFINITIONS
 
-const TTXWEB_VERSION = '1.4.0.660 (2023-08-10)';       // version string
+const TTXWEB_VERSION = '1.4.1.661 (2023-08-11)';       // version string
 
 // for user and template configuration see ttxweb_config.php
 
@@ -18,7 +18,9 @@
 // reveal    - 0 (hide concealed text, default) | 1 (reveal concealed text on load)
 // refresh   - seconds for auto refresh via XHR, 0 = disabled (default: set by TTXWEB_REFRESH in ttxweb_config.php)
 // template  - temporary template name (default: set by TTXWEB_TEMPLATE in ttxweb_config.php)
-// turn      - turn subpage on XHR refresh (default: turn according to TTXWEB_TURN_RATES in ttxweb_config.php)
+// turn      - 1 = turn subpage on XHR refresh (default: turn according to TTXWEB_TURN_RATES in ttxweb_config.php)
+// seqn0     - 1 = always display subpage 00 in custom header (default: only if page is in TTXWEB_TURN_RATES)
+// xhr       - 1 = output ttxStage only (only used internally for XMLHttpRefresh via ttxweb.js)
 
 
 // FUNCTION DEFINITONS
@@ -174,10 +176,12 @@ function pageExists($pageNum, $subpageNum) {
 if (empty($templateName)) { $templateName = 'default'; }
 
 // build query string to pass to the next query
+// with some more sanitizations
 $queryArray = $_GET;
 unset($queryArray['page']);
 unset($queryArray['sub']);
 unset($queryArray['xhr']);
+unset($queryArray['seqn0']);
 if (isset($queryArray['level15'])) {
     if ($queryArray['level15'] == '1') {
         unset($queryArray['level15']);
@@ -193,6 +197,14 @@ function pageExists($pageNum, $subpageNum) {
         unset($queryArray['reveal']);
     }
 }
+if (isset($queryArray['refresh'])) {
+    $queryArray['refresh'] = abs(filter_var($queryArray['refresh'], FILTER_SANITIZE_NUMBER_INT));
+}
+if (isset($queryArray['turn'])) {
+    if (!(($queryArray['turn'] == '1') || ($queryArray['turn'] == '0'))) {
+        unset($queryArray['turn']);
+    }
+}
 $queryString = htmlspecialchars(http_build_query($queryArray));
 if (!empty($queryString)) {
     $queryString = '&amp;' . $queryString;
@@ -229,6 +241,8 @@ function pageExists($pageNum, $subpageNum) {
 $origRefresh = $refresh;
 $origNextSubpageNum = $nextSubpageNum;
 if (isset($ttxTurnRates[$pageNum]) && !isset($_GET['sub'])) {
+    // page has a turnrate set in TTXWEB_TURN_RATES, so always
+    // display 00 as subpage number by default
     $refresh = $ttxTurnRates[$pageNum];
     $turn = true;
     $seqn0 = true;
@@ -246,6 +260,20 @@ function pageExists($pageNum, $subpageNum) {
         $nextSubpageNum = $origNextSubpageNum;
     }
 }
+if (isset($_GET['refresh'])) {
+        $refresh = $origRefresh;
+}
+
+// overwrite pages with turnrate if seqn0 URL parameter is set
+// 1 = always show subpage number 00
+if (isset($_GET['seqn0'])) {
+    if ($_GET['seqn0'] == '1') {
+        $seqn0 = true;
+    }
+    if ($_GET['seqn0'] == '0') {
+        $seqn0 = false;
+    }
+}
 
 // include header template if not requested from XMLHttpRequest
 if (!($xhr)) include($templateFolder . '/header.php');
diff --git a/js/ttxweb.js b/js/ttxweb.js
@@ -17,7 +17,7 @@ function xhrRefresh() {
   else {
     var nextSubpage = subpageNum + 1;
     if (nextSubpage > numSubpages) nextSubpage = 1;
-    var myXhrUrl = window.location.pathname + '?xhr=1&' + window.location.search.substring(1).replace('&sub=([0-9]{1,2})','') + '&sub=' + nextSubpage;
+    var myXhrUrl = window.location.pathname + ('?xhr=1&' + window.location.search.substring(1).replace('&sub=([0-9]{1,2})', '') + '&sub=' + nextSubpage).replace('&&', '&');
   }
 
   var myCurrentContents = document.createElement('div');
@@ -70,10 +70,10 @@ function xhrRefresh() {
 function renderRow0() {
   var myDate = new Date();
 
-  var myWeekDay = myDate.toLocaleString(document.getElementById('ttxLanguage').innerHTML, {weekday: 'long'}).substr(0, 2);
+  var myWeekDay = myDate.toLocaleString(document.getElementById('ttxLanguage').innerHTML, {weekday: 'long'}).substring(0, 2);
   var myMonth = zeroPad(myDate.getMonth() + 1);
   var myDay = zeroPad(myDate.getDate());
-  var myYear = zeroPad(myDate.getFullYear().toString().substr(-2));
+  var myYear = myDate.getFullYear().toString().substring(2, 4);
   var myHours = zeroPad(myDate.getHours());
   var myMinutes = zeroPad(myDate.getMinutes());
   var mySeconds = zeroPad(myDate.getSeconds());
@@ -209,6 +209,10 @@ function setNumPadFocus() {
   elem.select();
 }
 
+String.prototype.trim = function() {
+  return this.replace(/^\s\s*/, '').replace(/\s\s*$/, '');
+}
+
 var revealState = document.getElementById('ttxReveal').innerHTML;
 var refreshTimer = document.getElementById('ttxRefresh').innerHTML * 1000;
 var refreshState = (refreshTimer != 0);
