Tournament description improvements

deploy/database/schema.game.sql

@@ -17,7 +17,7 @@ CREATE TABLE game (
     last_winner_id     SMALLINT UNSIGNED,
     tournament_id      SMALLINT UNSIGNED,
     tournament_round_number SMALLINT UNSIGNED,
-    description        VARCHAR(255) NOT NULL,
+    description        VARCHAR(305) NOT NULL,
     chat               TEXT,
     previous_game_id   MEDIUMINT UNSIGNED,
     FOREIGN KEY (previous_game_id) REFERENCES game(id)

deploy/database/updates/03071_long_tournament_description.sql

@@ -0,0 +1 @@
+ALTER TABLE game MODIFY description VARCHAR(305) NOT NULL;

src/api/DummyApiResponder.php

@@ -224,6 +224,20 @@ protected function get_interface_response_loadGameData($args) {
         );
     }
 
+    protected function get_interface_response_loadTournaments($args) {
+        return $this->load_json_data_from_file(
+            'loadTournaments',
+            'noargs.json'
+        );
+    }
+
+    protected function get_interface_response_loadTournamentData($args) {
+        return $this->load_json_data_from_file(
+            'loadTournamentData',
+            $args['tournament'] . '.json'
+        );
+    }
+
     protected function get_interface_response_countPendingGames() {
         return $this->load_json_data_from_file(
             'countPendingGames',

src/engine/BMInterfaceTournament.php

@@ -503,17 +503,21 @@ protected function generate_new_games(BMTournament $tournament) {
                 array($gameData['buttonId1'], $gameData['buttonId2'])
             );
 
-            $description = 'Round ' . $gameData['roundNumber'];
-            if ('' != $tournament->description) {
-                $description = $tournament->description . ' ' . $description;
+            $roundDescription = 'Tournament Round ' . $gameData['roundNumber'];
+            $tournDescription = $tournament->description;
+
+            if ('' == trim($tournDescription)) {
+                $tournDescription = $roundDescription;
+            } else {
+                $tournDescription = $tournDescription . ' • ' . $roundDescription;
             }
 
             $interfaceResponse = $this->game()->create_game_from_button_ids(
                 array($gameData['playerId1'], $gameData['playerId2']),
                 array($gameData['buttonId1'], $gameData['buttonId2']),
                 $buttonNames,
                 $tournament->gameMaxWins,
-                $description,
+                $tournDescription,
                 NULL,
                 0, // needs to be non-null, but also a non-player ID
                 TRUE,

src/ui/js/Env.js

@@ -399,6 +399,8 @@ Env.applyBbCodeToHtml = function(htmlToParse) {
 
   var tagName;
 
+  htmlToParse = htmlToParse.replace(/\n/g, '<br>');
+
   while (htmlToParse) {
     var currentPattern = allStartTagsPattern;
     if (tagStack.length !== 0) {
@@ -413,28 +415,35 @@ Env.applyBbCodeToHtml = function(htmlToParse) {
     // should be greedy, so that nested tags work right
     // (E.g., in '...blah[/quote] blah [/quote] blah', we want the first .*
     // to end at the first [/quote], not the second)
-    currentPattern = '^(.*?)(?:' + currentPattern + ')(.*)$';
+    //
+    // Note that we are using [\\s\\S] instead of . so that we get
+    // multiline matching, see
+    //   https://simonwillison.net/2004/Sep/20/newlines/
+    // and
+    //   https://stackoverflow.com/questions/1979884/
+    //     how-to-use-javascript-regex-over-multiple-lines#16119722
+    currentPattern = '^([\\s\\S]*?)(?:' + currentPattern + ')([\\s\\S]*)$';
     // case-insensitive, multi-line
     var regExp = new RegExp(currentPattern, 'im');
 
-    var match = htmlToParse.match(regExp);
-    if (match) {
-      var stuffBeforeTag = match[1];
+    var matchStr = htmlToParse.match(regExp);
+    if (matchStr) {
+      var stuffBeforeTag = matchStr[1];
       // javascript apparently believes that capture groups that don't
       // match anything are just important as those that do. So we need
       // to do some acrobatics to find the ones we actually care about.
       // (match[0] is the whole matched string; match[1] is the stuff before
       // the tag. So we start with match[2].)
       tagName = '';
-      for (var i = 2; i < match.length; i++) {
-        tagName = match[i];
+      for (var i = 2; i < matchStr.length; i++) {
+        tagName = matchStr[i];
         if (tagName) {
           break;
         }
       }
       tagName = tagName.toLowerCase();
-      var tagParameter = match[i + 1] || '';
-      var stuffAfterTag = match[match.length - 1];
+      var tagParameter = matchStr[i + 1] || '';
+      var stuffAfterTag = matchStr[matchStr.length - 1];
 
       outputHtml += stuffBeforeTag;
       if (tagName.substring(0, 1) === '/') {
@@ -524,6 +533,140 @@ Env.applyBbCodeToHtml = function(htmlToParse) {
   return outputHtml;
 };
 
+Env.removeBbCodeFromHtml = function(htmlToParse) {
+  // This is all rather more complicated than one might expect, but any attempt
+  // to parse BB code using simple regular expressions rather than tokenization
+  // is in the same family as parsing HTML with regular expressions, which
+  // summons Zalgo.
+  // (See: http://stackoverflow.com/
+  //   questions/1732348/regex-match-open-tags-except-xhtml-self-contained-tags)
+
+  var replacements = {
+    'b': {},
+    'i': {},
+    'u': {},
+    's': {},
+    'code': {},
+    'spoiler': {},
+    'quote': {},
+    'game': {
+      'isAtomic': true,
+    },
+    'player': {
+      'isAtomic': true,
+    },
+    'button': {
+      'isAtomic': true,
+    },
+    'set': {
+      'isAtomic': true,
+    },
+    'tourn': {
+      'isAtomic': true,
+    },
+    'wiki': {
+      'isAtomic': true,
+    },
+    'issue': {
+      'isAtomic': true,
+    },
+    'forum': {},
+    '[': {
+      'isAtomic': true,
+    },
+  };
+
+  var outputHtml = '';
+  var tagStack = [];
+
+  // We want to build a pattern that we can use to identify any single
+  // BB code start tag
+  var allStartTagsPattern = '';
+  $.each(replacements, function(tagName) {
+    if (allStartTagsPattern !== '') {
+      allStartTagsPattern += '|';
+    }
+    // Matches, e.g., '[ b ]' or '[game = "123"]'
+    // The (?:... part means that we want parentheses around the whole
+    // thing (so we we can OR it together with other ones), but we don't
+    // want to capture the value of the whole thing as a group
+    allStartTagsPattern +=
+      '(?:\\[(' + Env.escapeRegexp(tagName) + ')(?:=([^\\]]*?))?])';
+  });
+
+  var tagName;
+
+  htmlToParse = htmlToParse.replace(/\n/g, ' ');
+
+  while (htmlToParse) {
+    var currentPattern = allStartTagsPattern;
+    if (tagStack.length !== 0) {
+      // The tag that was most recently opened
+      tagName = tagStack[tagStack.length - 1];
+      // Matches '[/i]' et al.
+      // (so that we can spot the end of the current tag as well)
+      currentPattern +=
+        '|(?:\\[(/' + Env.escapeRegexp(tagName) + ')])';
+    }
+    // The first group should be non-greedy (hence the ?), and the last one
+    // should be greedy, so that nested tags work right
+    // (E.g., in '...blah[/quote] blah [/quote] blah', we want the first .*
+    // to end at the first [/quote], not the second)
+    //
+    // Note that we are using [\\s\\S] instead of . so that we get
+    // multiline matching, see
+    //   https://simonwillison.net/2004/Sep/20/newlines/
+    // and
+    //   https://stackoverflow.com/questions/1979884/
+    //     how-to-use-javascript-regex-over-multiple-lines#16119722
+    currentPattern = '([\\s\\S]*?)(?:' + currentPattern + ')([\\s\\S]*)';
+
+    // case-insensitive, multi-line
+    var regExp = new RegExp(currentPattern, 'im');
+    var matchStr = htmlToParse.match(regExp);
+
+    if (matchStr) {
+      var stuffBeforeTag = matchStr[1];
+      // javascript apparently believes that capture groups that don't
+      // match anything are just important as those that do. So we need
+      // to do some acrobatics to find the ones we actually care about.
+      // (match[0] is the whole matched string; match[1] is the stuff before
+      // the tag. So we start with match[2].)
+      tagName = '';
+      for (var i = 2; i < matchStr.length; i++) {
+        tagName = matchStr[i];
+        if (tagName) {
+          break;
+        }
+      }
+      tagName = tagName.toLowerCase();
+      var stuffAfterTag = matchStr[matchStr.length - 1];
+
+      outputHtml += stuffBeforeTag;
+      if (tagName.substring(0, 1) === '/') {
+        // If we've found our closing tag, we can finish the current tag and
+        // pop it off the stack
+        tagName = tagStack.pop();
+      } else {
+        if (!replacements[tagName].isAtomic) {
+          // If there's a closing tag coming along later, push this tag
+          // on the stack so we'll know we're waiting on it
+          tagStack.push(tagName);
+        }
+      }
+
+      htmlToParse = stuffAfterTag;
+    } else {
+      // If we don't find any more BB code tags that we're interested in,
+      // then we must have reached the end
+      outputHtml += htmlToParse;
+      htmlToParse = '';
+    }
+  }
+
+  return outputHtml;
+};
+
 Env.escapeRegexp = function(str) {
   return str.replace(/([.?*+^$[\]\\(){}|-])/g, '\\$1');
 };

src/ui/js/Game.js

@@ -1836,7 +1836,7 @@ Game.pageAddGameHeader = function(action_desc) {
 
   if (Api.game.description) {
     Game.page.append($('<div>', {
-      'text': Api.game.description,
+      'html': Env.applyBbCodeToHtml(Api.game.description),
       'class': 'gameDescDisplay',
     }));
   }

src/ui/js/Overview.js

@@ -443,9 +443,11 @@ Overview.addScoreCol = function(gameRow, gameInfo) {
 
 Overview.addDescCol = function(gameRow, description) {
   var descText = '';
-  if (typeof(description) == 'string') {
-    descText = description.substring(0, 30) +
-               ((description.length > 30) ? '...' : '');
+  if (typeof(description) === 'string') {
+    var descriptionNoMarkup = Env.removeBbCodeFromHtml(description);
+
+    descText = descriptionNoMarkup.substring(0, 30) +
+               ((descriptionNoMarkup.length > 30) ? '...' : '');
   }
   gameRow.append($('<td>', {
     'class': 'gameDescDisplay',

src/ui/js/Tournament.js

@@ -166,13 +166,7 @@ Tournament.pageAddTournamentHeader = function() {
 //    bgcolor = Tournament.color.opponent;
 //  }
 
-  if (Api.tournament.description) {
-    Tournament.page.append($('<div>', {
-      'text': Api.tournament.description,
-      'class': 'gameDescDisplay',
-    }));
-  }
-
+  Tournament.pageAddTournamentDescription();
   Tournament.page.append($('<br>'));
 
   Tournament.pageAddTournamentInfo();
@@ -306,8 +300,23 @@ Tournament.formFollowTournament = function(e) {
     Tournament.showLoggedInPage);
 };
 
+Tournament.pageAddTournamentDescription = function () {
+  if (Api.tournament.description) {
+    Tournament.page.append($('<div>', {
+      'id': 'tournament_desc',
+      'html': Env.applyBbCodeToHtml(Api.tournament.description),
+      'class': 'gameDescDisplay',
+    }));
+  }
+};
+
 Tournament.pageAddTournamentInfo = function () {
-  var infoDiv = $('<div>');
+  var infoDiv = $(
+    '<div>',
+    {
+      'id': 'tournament_info',
+    }
+  );
   Tournament.page.append(infoDiv);
 
   var tournamentTypePar = $('<p>', {
@@ -347,9 +356,18 @@ Tournament.pageAddWinnerInfo = function () {
   var winnerDiv = $('<div>');
   Tournament.page.append(winnerDiv);
 
-  var winnerIdx = Api.tournament.remainCountArray.findIndex(
-    function(x) {return (x > 0);}
+  var winnerIdx;
+  var isWinnerFound = Api.tournament.remainCountArray.some(
+    function(remainCount, idx) {
+      winnerIdx = idx;
+      return remainCount > 0;
+    }
   );
+
+  if (!isWinnerFound) {
+    return;
+  }
+
   var winnerPar = $('<p>', {
     'class': 'winner_name',
     'text': 'Winner: ' + Api.tournament.playerDataArray[winnerIdx].playerName

src/ui/js/TournamentOverview.js

@@ -284,8 +284,10 @@ TournamentOverview.addTypeCol = function(tournamentRow, tournamentInfo) {
 TournamentOverview.addDescCol = function(tournamentRow, description) {
   var descText = '';
   if (typeof(description) === 'string') {
-    descText = description.substring(0, 30) +
-               ((description.length > 30) ? '...' : '');
+    var descriptionNoMarkup = Env.removeBbCodeFromHtml(description);
+
+    descText = descriptionNoMarkup.substring(0, 30) +
+               ((descriptionNoMarkup.length > 30) ? '...' : '');
   }
   tournamentRow.append($('<td>', {
     'class': 'tournamentDescDisplay',

test/src/api/responderTestFramework.php

@@ -1511,6 +1511,33 @@ protected function verify_api_setChatVisibility($expMessage, $gameId, $private)
         $this->cache_json_api_output('setChatVisibility', $fakeGameNumber, $retval);
     }
 
+
+    protected function verify_api_loadTournaments($expData) {
+        $args = array(
+            'type' => 'loadTournaments',
+        );
+        $retval = $this->verify_api_success($args);
+
+        $fullData = $retval['data'];
+
+        // Now restrict the data to include only the information for Tournament 1,
+        // since this is the tournament that will be generated with an empty database.
+        //
+        // This slicing makes the test code less fragile when testing with an AMP stack
+        // since the database need not be deleted each time the tests run.
+        $tournamentIdx = array_search(1, $fullData['tournamentIdArray'], TRUE);
+        $this->assertEquals(FALSE, is_bool($tournamentIdx), 'Tournament 1 should exist');
+
+        $slicedData = array();
+        foreach ($fullData as $key => $value) {
+            $slicedData[$key] = array($value[$tournamentIdx]);
+        }
+
+        $this->assertEquals($expData, $slicedData);
+
+        $this->cache_json_api_output('loadTournaments', 'noargs', $retval);
+    }
+
     /*
      * verify_api_loadTournamentData() - helper routine which calls the API
      * loadTournamentData method, makes standard assertions about its