X-Git-Url: https://git.cweiske.de/stouyapi.git/blobdiff_plain/b599dd949af8f15641d5d7487bd3801a92ed1ca0..HEAD:/bin/import-game-data.php

diff --git a/bin/import-game-data.php b/bin/import-game-data.php
index 97486ff..854b3d6 100755
--- a/bin/import-game-data.php
+++ b/bin/import-game-data.php
@@ -7,23 +7,54 @@
  * @author Christian Weiske <cweiske@cweiske.de>
  */
 ini_set('xdebug.halt_level', E_WARNING|E_NOTICE|E_USER_WARNING|E_USER_NOTICE);
+require_once __DIR__ . '/functions.php';
 require_once __DIR__ . '/filters.php';
-if (!isset($argv[1])) {
+
+//command line option parsing
+$optind = null;
+$opts = getopt('h', ['help', 'mini', 'noqr'], $optind);
+$args = array_slice($argv, $optind);
+
+if (isset($opts['help']) || isset($opts['h'])) {
+    echo "Import games from a OUYA game data repository\n";
+    echo "\n";
+    echo "Usage: import-game-data.php [--mini] [--noqr] [--help|-h]\n";
+    echo " --mini  Generate small but ugly JSON files\n";
+    echo " --noqr  Do not generate and link QR code images\n";
+    exit(0);
+}
+
+if (!isset($args[0])) {
     error('Pass the path to a "folders" file with game data json files folder names');
 }
-$foldersFile = $argv[1];
+$foldersFile = $args[0];
 if (!is_file($foldersFile)) {
     error('Given path is not a file: ' . $foldersFile);
 }
 
-$GLOBALS['packagelists']['cweiskepicks'] = [
-    'de.eiswuxe.blookid2',
-    'com.cosmos.babyloniantwins',
-    'com.inverseblue.skyriders',
-];
+$cfgMini     = isset($opts['mini']);
+$cfgEnableQr = !isset($opts['noqr']);
+
+
+//default configuration values
+$GLOBALS['baseUrl']      = 'http://ouya.cweiske.de/';
+$GLOBALS['categorySubtitles'] = [];
+$GLOBALS['packagelists'] = [];
+$GLOBALS['urlRewrites']  = [];
+$cfgFile = __DIR__ . '/../config.php';
+if (file_exists($cfgFile)) {
+    include $cfgFile;
+}
 
 $wwwDir = __DIR__ . '/../www/';
 
+if ($cfgEnableQr) {
+    $qrDir = $wwwDir . 'gen-qr/';
+    if (!is_dir($qrDir)) {
+        mkdir($qrDir, 0775);
+    }
+}
+
 $baseDir   = dirname($foldersFile);
 $gameFiles = [];
 foreach (file($foldersFile) as $line) {
@@ -40,9 +71,18 @@ foreach (file($foldersFile) as $line) {
     }
 }
 
+//store git repository version of last folder
+$workdir = getcwd();
+chdir($folder);
+$gitDate = `git log --max-count=1 --format="%h %cI"`;
+chdir($workdir);
+file_put_contents($wwwDir . '/game-data-version', $gitDate);
+
 $games = [];
 $count = 0;
 $developers = [];
+
+//load game data. doing early to collect a developer's games
 foreach ($gameFiles as $gameFile) {
     $game = json_decode(file_get_contents($gameFile));
     if ($game === null) {
@@ -51,18 +91,18 @@ foreach ($gameFiles as $gameFile) {
     addMissingGameProperties($game);
     $games[$game->packageName] = $game;
 
-    writeJson(
-        'api/v1/details-data/' . $game->packageName . '.json',
-        buildDetails($game)
-    );
-
     if (!isset($developers[$game->developer->uuid])) {
         $developers[$game->developer->uuid] = [
-            'info'     => $game->developer,
-            'products' => [],
+            'info'      => $game->developer,
+            'products'  => [],
+            'gameNames' => [],
         ];
     }
+    $developers[$game->developer->uuid]['gameNames'][] = $game->packageName;
+}
 
+//write json api files
+foreach ($games as $game) {
     $products = $game->products ?? [];
     foreach ($products as $product) {
         writeJson(
@@ -73,7 +113,14 @@ foreach ($gameFiles as $gameFile) {
         $developers[$game->developer->uuid]['products'][] = $product;
     }
 
-    /**/
+    writeJson(
+        'api/v1/details-data/' . $game->packageName . '.json',
+        buildDetails(
+            $game,
+            count($developers[$game->developer->uuid]['gameNames']) > 1
+        )
+    );
+
     writeJson(
         'api/v1/games/' . $game->packageName . '/purchases',
         buildPurchases($game)
@@ -109,14 +156,25 @@ foreach ($developers as $developer) {
         buildDeveloperProducts($developer['products'], $developer['info'])
     );
     writeJson(
-        //index.htm does not need a rewrite rule
         'api/v1/developers/' . $developer['info']->uuid
         . '/current_gamer',
         buildDeveloperCurrentGamer()
     );
+
+    if (count($developer['gameNames']) > 1) {
+        writeJson(
+            'api/v1/discover-data/dev--' . $developer['info']->uuid . '.json',
+            buildSpecialCategory(
+                'Developer: ' . $developer['info']->name,
+                filterByPackageNames($games, $developer['gameNames'])
+            )
+        );
+    }
 }
 
-writeJson('api/v1/discover-data/discover.json', buildDiscover($games));
+$data = buildDiscover($games);
+writeJson('api/v1/discover-data/discover.json', $data);
+writeJson('api/v1/discover-data/discover.forge.json', convertCategoryToForge($data));
 writeJson('api/v1/discover-data/home.json', buildDiscoverHome($games));
 
 //make
@@ -145,41 +203,55 @@ function buildDiscover(array $games)
     ];
 
     addDiscoverRow(
-        $data, 'Last Updated',
-        filterLastUpdated($games, 10)
-    );
-    addDiscoverRow(
-        $data, 'Best rated',
-        filterBestRated($games, 10)
+        $data, 'New games',
+        filterLastAdded($games, 10)
     );
     addDiscoverRow(
-        $data, "cweiske's picks",
-        filterByPackageNames($games, $GLOBALS['packagelists']['cweiskepicks'])
+        $data, 'Best rated games',
+        filterBestRatedGames($games, 10),
+        true
     );
 
+    foreach ($GLOBALS['packagelists'] as $listTitle => $listPackageNames) {
+        addDiscoverRow(
+            $data, $listTitle,
+            filterByPackageNames($games, $listPackageNames)
+        );
+    }
+
     addDiscoverRow(
         $data, 'Special',
         [
             'Best rated',
+            'Best rated games',
             'Most rated',
             'Random',
+            'Last updated',
         ]
     );
-    writeJson(
+    writeCategoryJson(
         'api/v1/discover-data/' . categoryPath('Best rated') . '.json',
         buildSpecialCategory('Best rated', filterBestRated($games, 99))
     );
-    writeJson(
+    writeCategoryJson(
+        'api/v1/discover-data/' . categoryPath('Best rated games') . '.json',
+        buildSpecialCategory('Best rated games', filterBestRatedGames($games, 99))
+    );
+    writeCategoryJson(
         'api/v1/discover-data/' . categoryPath('Most rated') . '.json',
         buildSpecialCategory('Most rated', filterMostDownloaded($games, 99))
     );
-    writeJson(
+    writeCategoryJson(
         'api/v1/discover-data/' . categoryPath('Random') . '.json',
         buildSpecialCategory(
             'Random ' . date('Y-m-d H:i'),
             filterRandom($games, 99)
         )
     );
+    writeCategoryJson(
+        'api/v1/discover-data/' . categoryPath('Last updated') . '.json',
+        buildSpecialCategory('Last updated', filterLastUpdated($games, 99))
+    );
 
     $players = [
         //1 => '1 player',
@@ -189,9 +261,20 @@ function buildDiscover(array $games)
     ];
     addDiscoverRow($data, 'Multiplayer', $players);
     foreach ($players as $num => $title) {
-        writeJson(
+        writeCategoryJson(
             'api/v1/discover-data/' . categoryPath($title) . '.json',
-            buildDiscoverCategory($title, filterByPlayers($games, $num))
+            buildDiscoverCategory(
+                $title,
+                //I do not want emulators here,
+                // and neither Streaming apps
+                filterByGenre(
+                    filterByGenre(
+                        filterByPlayers($games, $num),
+                        'Emulator', true
+                    ),
+                    'App', true
+                )
+            )
         );
     }
 
@@ -199,7 +282,7 @@ function buildDiscover(array $games)
     natsort($ages);
     addDiscoverRow($data, 'Content rating', $ages);
     foreach ($ages as $num => $title) {
-        writeJson(
+        writeCategoryJson(
             'api/v1/discover-data/' . categoryPath($title) . '.json',
             buildDiscoverCategory($title, filterByAge($games, $title))
         );
@@ -210,7 +293,7 @@ function buildDiscover(array $games)
     addChunkedDiscoverRows($data, $genres, 'Genres');
 
     foreach ($genres as $genre) {
-        writeJson(
+        writeCategoryJson(
             'api/v1/discover-data/' . categoryPath($genre) . '.json',
             buildDiscoverCategory($genre, filterByGenre($games, $genre))
         );
@@ -219,7 +302,7 @@ function buildDiscover(array $games)
     $abc = array_merge(range('A', 'Z'), ['Other']);
     addChunkedDiscoverRows($data, $abc, 'Alphabetical');
     foreach ($abc as $letter) {
-        writeJson(
+        writeCategoryJson(
             'api/v1/discover-data/' . categoryPath($letter) . '.json',
             buildDiscoverCategory($letter, filterByLetter($games, $letter))
         );
@@ -238,21 +321,69 @@ function buildDiscoverCategory($name, $games)
         'rows'  => [],
         'tiles' => [],
     ];
-    addDiscoverRow(
-        $data, 'Last Updated',
-        filterLastUpdated($games, 10)
-    );
-    addDiscoverRow(
-        $data, 'Best rated',
-        filterBestRated($games, 10)
-    );
+    if (isset($GLOBALS['categorySubtitles'][$name])) {
+        $data['stouyapi']['subtitle'] = $GLOBALS['categorySubtitles'][$name];
+    }
+
+    if (count($games) >= 20) {
+        addDiscoverRow(
+            $data, 'Last updated',
+            filterLastUpdated($games, 10)
+        );
+        addDiscoverRow(
+            $data, 'Best rated',
+            filterBestRated($games, 10),
+            true
+        );
+    }
 
     $games = sortByTitle($games);
     $chunks = array_chunk($games, 4);
+    $title = 'All';
     foreach ($chunks as $chunkGames) {
-        addDiscoverRow($data, '', $chunkGames);
+        addDiscoverRow($data, $title, $chunkGames);
+        $title = '';
+    }
+
+    return $data;
+}
+
+/**
+ * Modify a category to make it suitable for the Razer Forge TV
+ *
+ * - Fold rows without title into the previous row
+ * - Remove automatically generated categories ("Last updated", "Best rated")
+ *
+ * @see buildDiscoverCategory()
+ */
+function convertCategoryToForge($data, $removeAutoCategories = false)
+{
+    //merge tiles from rows without title into the previous row
+    $lastTitleRowId = null;
+    foreach ($data['rows'] as $rowId => $row) {
+        if ($row['title'] !== '') {
+            $lastTitleRowId = $rowId;
+        } else if ($lastTitleRowId !== null) {
+            $data['rows'][$lastTitleRowId]['tiles'] = array_merge(
+                $data['rows'][$lastTitleRowId]['tiles'],
+                $row['tiles']
+            );
+            unset($data['rows'][$rowId]);
+        }
+    }
+
+    if ($removeAutoCategories) {
+        foreach ($data['rows'] as $rowId => $row) {
+            if ($row['title'] === 'Last updated'
+                || $row['title'] === 'Best rated'
+            ) {
+                unset($data['rows'][$rowId]);
+            }
+        }
     }
 
+    $data['rows'] = array_values($data['rows']);
+
     return $data;
 }
 
@@ -270,6 +401,11 @@ function buildMakeCategory($name, $games)
     return $data;
 }
 
+/**
+ * Category without the "Last updated" or "Best rated" top rows
+ *
+ * Used for "Best rated", "Most rated", "Random"
+ */
 function buildSpecialCategory($name, $games)
 {
     $data = [
@@ -291,19 +427,29 @@ function buildSpecialCategory($name, $games)
 
 function buildDiscoverHome(array $games)
 {
-    //we do not want anything here for now
     $data = [
         'title' => 'home',
         'rows'  => [
-            [
-                'title' => 'FEATURED',
-                'showPrice' => false,
-                'ranked'    => false,
-                'tiles'     => [],
-            ]
         ],
         'tiles' => [],
     ];
+
+    if (isset($GLOBALS['home'])) {
+        reset($GLOBALS['home']);
+        $title = key($GLOBALS['home']);
+        addDiscoverRow(
+            $data, $title,
+            filterByPackageNames($games, $GLOBALS['home'][$title])
+        );
+    } else {
+        $data['rows'][] = [
+            'title'     => 'FEATURED',
+            'showPrice' => false,
+            'ranked'    => false,
+            'tiles'     => [],
+        ];
+    }
+
     return $data;
 }
 
@@ -395,7 +541,7 @@ function buildProduct($product)
 /**
  * Build /app/v1/details?app=org.example.game
  */
-function buildDetails($game)
+function buildDetails($game, $linkDeveloperPage = false)
 {
     $latestRelease = $game->latestRelease;
 
@@ -414,15 +560,17 @@ function buildDetails($game)
             $mediaTiles[] = [
                 'type' => 'image',
                 'urls' => [
-                    'thumbnail' => $medium->thumb,
+                    'thumbnail' => $medium->thumb ?? $medium->url,
                     'full'      => $medium->url,
                 ],
             ];
         } else {
-            $mediaTiles[] = [
-                'type' => 'video',
-                'url'  => $medium->url,
-            ];
+            if (!isUnsupportedVideoUrl($medium->url)) {
+                $mediaTiles[] = [
+                    'type' => 'video',
+                    'url'  => $medium->url,
+                ];
+            }
         }
     }
 
@@ -441,11 +589,25 @@ function buildDetails($game)
         $product = buildProduct($gamePromoted);
     }
 
+    $iaUrl = null;
+    if (isset($game->latestRelease->url)
+        && substr($game->latestRelease->url, 0, 29) == 'https://archive.org/download/'
+    ) {
+        $iaUrl = dirname($game->latestRelease->url) . '/';
+    }
+
+    $description = $game->description;
+    if (isset($game->notes) && trim($game->notes)) {
+        $description = "Technical notes:\r\n" . $game->notes
+            . "\r\n----\r\n"
+            . $description;
+    }
+
     // http://cweiske.de/ouya-store-api-docs.htm#get-https-devs-ouya-tv-api-v1-details
-    return [
+    $data = [
         'type'             => 'Game',
         'title'            => $game->title,
-        'description'      => $game->description,
+        'description'      => $description,
         'gamerNumbers'     => $game->players,
         'genres'           => $game->genres,
 
@@ -499,7 +661,19 @@ function buildDetails($game)
 
         'promotedProduct' => $product,
         'buttons'         => $buttons,
+
+        'stouyapi' => [
+            'internet-archive' => $iaUrl,
+            'developer-url'    => $game->developer->website ?? null,
+        ]
     ];
+
+    if ($linkDeveloperPage) {
+        $data['developer']['url'] = 'ouya://launcher/discover/dev--'
+            . categoryPath($game->developer->uuid);
+    }
+
+    return $data;
 }
 
 function buildDeveloperCurrentGamer()
@@ -531,6 +705,9 @@ function buildDeveloperProductOnly($product, $developer)
  */
 function buildDeveloperProducts($products, $developer)
 {
+    //remove duplicates
+    $products = array_values(array_column($products, null, 'identifier'));
+
     $jsonProducts = [];
     foreach ($products as $product) {
         $jsonProducts[] = buildProduct($product);
@@ -607,12 +784,12 @@ function addChunkedDiscoverRows(&$data, $games, $title)
     }
 }
 
-function addDiscoverRow(&$data, $title, $games)
+function addDiscoverRow(&$data, $title, $games, $ranked = false)
 {
     $row = [
         'title'     => $title,
         'showPrice' => true,
-        'ranked'    => false,
+        'ranked'    => $ranked,
         'tiles'     => [],
     ];
     foreach ($games as $game) {
@@ -691,11 +868,6 @@ function buildDiscoverGameTile($game)
     ];
 }
 
-function categoryPath($title)
-{
-    return str_replace(['/', '\\', ' ', '+', '?'], '_', $title);
-}
-
 function getAllAges($games)
 {
     $ages = [];
@@ -716,6 +888,8 @@ function getAllGenres($games)
 
 function addMissingGameProperties($game)
 {
+    global $cfgEnableQr;
+
     if (!isset($game->overview)) {
         $game->overview = null;
     }
@@ -754,9 +928,14 @@ function addMissingGameProperties($game)
         $game->rating->count = 0;
     }
 
+    $game->firstRelease  = null;
     $game->latestRelease = null;
+    $firstReleaseTimestamp  = null;
     $latestReleaseTimestamp = 0;
     foreach ($game->releases as $release) {
+        if (isset($release->broken) && $release->broken) {
+            continue;
+        }
         if (!isset($release->publicSize)) {
             $release->publicSize = 0;
         }
@@ -769,6 +948,15 @@ function addMissingGameProperties($game)
             $game->latestRelease    = $release;
             $latestReleaseTimestamp = $releaseTimestamp;
         }
+        if ($firstReleaseTimestamp === null
+            || $releaseTimestamp < $firstReleaseTimestamp
+        ) {
+            $game->firstRelease    = $release;
+            $firstReleaseTimestamp = $releaseTimestamp;
+        }
+    }
+    if ($game->firstRelease === null) {
+        error('No first release for ' . $game->packageName);
     }
     if ($game->latestRelease === null) {
         error('No latest release for ' . $game->packageName);
@@ -793,6 +981,34 @@ function addMissingGameProperties($game)
     if (!isset($game->developer->founder)) {
         $game->developer->founder = false;
     }
+
+    if ($cfgEnableQr && $game->website) {
+        $qrfileName = preg_replace('#[^\\w\\d._-]#', '_', $game->website) . '.png';
+        $qrfilePath = $GLOBALS['qrDir'] . $qrfileName;
+        if (!file_exists($qrfilePath)) {
+            $cmd = __DIR__ . '/create-qr.sh'
+                 . ' ' . escapeshellarg($game->website)
+                 . ' ' . escapeshellarg($qrfilePath);
+            passthru($cmd, $retval);
+            if ($retval != 0) {
+                exit(20);
+            }
+        }
+        $qrUrlPath = $GLOBALS['baseUrl'] . 'gen-qr/' . $qrfileName;
+        $game->media[] = (object) [
+            'type' => 'image',
+            'url'  => $qrUrlPath,
+        ];
+    }
+
+    //rewrite urls from Internet Archive to our servers
+    $game->discover = rewriteUrl($game->discover);
+    foreach ($game->media as $medium) {
+        $medium->url = rewriteUrl($medium->url);
+    }
+    foreach ($game->releases as $release) {
+        $release->url = rewriteUrl($release->url);
+    }
 }
 
 /**
@@ -852,6 +1068,16 @@ function getPromotedProduct($game)
     return null;
 }
 
+/**
+ * vimeo only work with HTTPS now,
+ * and the OUYA does not support SNI.
+ * We get SSL errors and no video for them :/
+ */
+function isUnsupportedVideoUrl($url)
+{
+    return strpos($url, '://vimeo.com/') !== false;
+}
+
 function removeMakeGames(array $games)
 {
     return filterByGenre($games, 'Tutorials', true);
@@ -868,20 +1094,41 @@ function removeMakeGenres($genres)
     return $filtered;
 }
 
+function rewriteUrl($url)
+{
+    foreach ($GLOBALS['urlRewrites'] as $pattern => $replacement) {
+        $url = preg_replace($pattern, $replacement, $url);
+    }
+    return $url;
+}
+
 function writeJson($path, $data)
 {
-    global $wwwDir;
+    global $cfgMini, $wwwDir;
     $fullPath = $wwwDir . $path;
     $dir = dirname($fullPath);
     if (!is_dir($dir)) {
         mkdir($dir, 0777, true);
     }
+    $opts = JSON_UNESCAPED_SLASHES;
+    if (!$cfgMini) {
+        $opts |= JSON_PRETTY_PRINT;
+    }
     file_put_contents(
         $fullPath,
-        json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) . "\n"
+        json_encode($data, $opts) . "\n"
     );
 }
 
+function writeCategoryJson($path, $data)
+{
+    writeJson($path, $data);
+
+    $forgePath = str_replace('.json', '.forge.json', $path);
+    $forgeData = convertCategoryToForge($data, true);
+    writeJson($forgePath, $forgeData);
+}
+
 function error($msg)
 {
     fwrite(STDERR, $msg . "\n");