bin/import-game-data.php

   1 #!/usr/bin/env php
   2 <?php
   3 /**
   4  * Import games from a OUYA game data repository
   5  *
   6  * @link https://github.com/cweiske/ouya-game-data/
   7  * @author Christian Weiske <cweiske@cweiske.de>
   8  */
   9 ini_set('xdebug.halt_level', E_WARNING|E_NOTICE|E_USER_WARNING|E_USER_NOTICE);
  10 require_once __DIR__ . '/filters.php';
  11 if (!isset($argv[1])) {
  12     error('Pass the path to a "folders" file with game data json files folder names');
  13 }
  14 $foldersFile = $argv[1];
  15 if (!is_file($foldersFile)) {
  16     error('Given path is not a file: ' . $foldersFile);
  17 }
  18
  19 $GLOBALS['packagelists']['cweiskepicks'] = [
  20     'de.eiswuxe.blookid2',
  21     'com.cosmos.babyloniantwins'
  22 ];
  23
  24 $wwwDir = __DIR__ . '/../www/';
  25
  26 $baseDir   = dirname($foldersFile);
  27 $gameFiles = [];
  28 foreach (file($foldersFile) as $line) {
  29     $line = trim($line);
  30     if (strlen($line)) {
  31         if (strpos($line, '..') !== false) {
  32             error('Path attack in ' . $folder);
  33         }
  34         $folder = $baseDir . '/' . $line;
  35         if (!is_dir($folder)) {
  36             error('Folder does not exist: ' . $folder);
  37         }
  38         $gameFiles = array_merge($gameFiles, glob($folder . '/*.json'));
  39     }
  40 }
  41
  42 $games = [];
  43 $count = 0;
  44 foreach ($gameFiles as $gameFile) {
  45     $game = json_decode(file_get_contents($gameFile));
  46     if ($game === null) {
  47         error('JSON invalid at ' . $gameFile);
  48     }
  49     addMissingGameProperties($game);
  50     $games[$game->packageName] = $game;
  51
  52     writeJson(
  53         'api/v1/details-data/' . $game->packageName . '.json',
  54         buildDetails($game)
  55     );
  56     /* this crashes babylonian twins
  57     writeJson(
  58         'api/v1/games/' . $game->packageName . '/purchases',
  59         "{}\n"
  60     );
  61     */
  62
  63     writeJson(
  64         'api/v1/apps/' . $game->packageName . '.json',
  65         buildApps($game)
  66     );
  67     $latestRelease = $game->latestRelease;
  68     writeJson(
  69         'api/v1/apps/' . $latestRelease->uuid . '.json',
  70         buildApps($game)
  71     );
  72
  73     writeJson(
  74         'api/v1/apps/' . $latestRelease->uuid . '-download.json',
  75         buildAppDownload($game, $latestRelease)
  76     );
  77
  78     if ($count++ > 20) {
  79         //break;
  80     }
  81 }
  82
  83 writeJson('api/v1/discover-data/discover.json', buildDiscover($games));
  84 writeJson('api/v1/discover-data/home.json', buildDiscoverHome($games));
  85
  86
  87 function buildDiscover(array $games)
  88 {
  89     $data = [
  90         'title' => 'DISCOVER',
  91         'rows'  => [],
  92         'tiles' => [],
  93     ];
  94
  95     addDiscoverRow(
  96         $data, 'Last Updated',
  97         filterLastUpdated($games, 10)
  98     );
  99     addDiscoverRow(
 100         $data, 'Best rated',
 101         filterBestRated($games, 10)
 102     );
 103     addDiscoverRow(
 104         $data, "cweiske's picks",
 105         filterByPackageNames($games, $GLOBALS['packagelists']['cweiskepicks'])
 106     );
 107
 108     $players = [
 109         //1 => '1 player',
 110         2 => '2 players',
 111         3 => '3 players',
 112         4 => '4 players',
 113     ];
 114     addDiscoverRow($data, '# of players', $players);
 115     foreach ($players as $num => $title) {
 116         writeJson(
 117             'api/v1/discover-data/' . categoryPath($title) . '.json',
 118             buildDiscoverCategory($title, filterByPlayers($games, $num))
 119         );
 120     }
 121
 122     $ages = getAllAges($games);
 123     natsort($ages);
 124     addDiscoverRow($data, 'Content rating', $ages);
 125     foreach ($ages as $num => $title) {
 126         writeJson(
 127             'api/v1/discover-data/' . categoryPath($title) . '.json',
 128             buildDiscoverCategory($title, filterByAge($games, $title))
 129         );
 130     }
 131
 132     $genres = getAllGenres($games);
 133     sort($genres);
 134     addChunkedDiscoverRows($data, $genres, 'Genres');
 135
 136     foreach ($genres as $genre) {
 137         writeJson(
 138             'api/v1/discover-data/' . categoryPath($genre) . '.json',
 139             buildDiscoverCategory($genre, filterByGenre($games, $genre))
 140         );
 141     }
 142
 143     $abc = array_merge(range('A', 'Z'), ['Other']);
 144     addChunkedDiscoverRows($data, $abc, 'Alphabetical');
 145     foreach ($abc as $letter) {
 146         writeJson(
 147             'api/v1/discover-data/' . categoryPath($letter) . '.json',
 148             buildDiscoverCategory($letter, filterByLetter($games, $letter))
 149         );
 150     }
 151
 152     return $data;
 153 }
 154
 155 /**
 156  * A genre category page
 157  */
 158 function buildDiscoverCategory($name, $games)
 159 {
 160     $data = [
 161         'title' => $name,
 162         'rows'  => [],
 163         'tiles' => [],
 164     ];
 165     addDiscoverRow(
 166         $data, 'Last Updated',
 167         filterLastUpdated($games, 10)
 168     );
 169     addDiscoverRow(
 170         $data, 'Best rated',
 171         filterBestRated($games, 10)
 172     );
 173
 174     usort(
 175         $games,
 176         function ($gameA, $gameB) {
 177             return strcmp($gameA->title, $gameB->title);
 178         }
 179     );
 180     $chunks = array_chunk($games, 4);
 181     foreach ($chunks as $chunkGames) {
 182         addDiscoverRow($data, '', $chunkGames);
 183     }
 184
 185     return $data;
 186 }
 187
 188 function buildDiscoverHome(array $games)
 189 {
 190     //we do not want anything here for now
 191     $data = [
 192         'title' => 'home',
 193         'rows'  => [
 194             [
 195                 'title' => 'FEATURED',
 196                 'showPrice' => false,
 197                 'ranked'    => false,
 198                 'tiles'     => [],
 199             ]
 200         ],
 201         'tiles' => [],
 202     ];
 203     return $data;
 204 }
 205
 206 /**
 207  * Build api/v1/apps/$packageName
 208  */
 209 function buildApps($game)
 210 {
 211     $latestRelease = $game->latestRelease;
 212
 213     // http://cweiske.de/ouya-store-api-docs.htm#get-https-devs-ouya-tv-api-v1-apps-xxx
 214     return [
 215         'app' => [
 216             'uuid'          => $latestRelease->uuid,
 217             'title'         => $game->title,
 218             'overview'      => $game->overview,
 219             'description'   => $game->description,
 220             'gamerNumbers'  => $game->players,
 221             'genres'        => $game->genres,
 222
 223             'website'       => $game->website,
 224             'contentRating' => $game->contentRating,
 225             'premium'       => $game->premium,
 226             'firstPublishedAt' => $game->firstPublishedAt,
 227
 228             'likeCount'     => $game->rating->likeCount,
 229             'ratingAverage' => $game->rating->average,
 230             'ratingCount'   => $game->rating->count,
 231
 232             'versionNumber' => $latestRelease->name,
 233             'latestVersion' => $latestRelease->uuid,
 234             'md5sum'        => $latestRelease->md5sum,
 235             'apkFileSize'   => $latestRelease->size,
 236             'publishedAt'   => $latestRelease->date,
 237             'publicSize'    => $latestRelease->publicSize,
 238             'nativeSize'    => $latestRelease->nativeSize,
 239
 240             'mainImageFullUrl' => $game->discover,
 241             'videoUrl'         => getFirstVideoUrl($game->media),
 242             'filepickerScreenshots' => getAllImageUrls($game->media),
 243             'mobileAppIcon'    => null,
 244
 245             'developer'           => $game->developer->name,
 246             'supportEmailAddress' => $game->developer->supportEmail,
 247             'supportPhone'        => $game->developer->supportPhone,
 248             'founder'             => $game->developer->founder,
 249
 250             'promotedProduct' => null,
 251         ],
 252     ];
 253 }
 254
 255 function buildAppDownload($game, $release)
 256 {
 257     return [
 258         'app' => [
 259             'fileSize'      => $release->size,
 260             'version'       => $release->uuid,
 261             'contentRating' => $game->contentRating,
 262             'downloadLink'  => $release->url,
 263         ]
 264     ];
 265 }
 266
 267 /**
 268  * Build /app/v1/details?app=org.example.game
 269  */
 270 function buildDetails($game)
 271 {
 272     $latestRelease = $game->latestRelease;
 273
 274     $mediaTiles = [];
 275     if ($game->discover) {
 276         $mediaTiles[] = [
 277             'type' => 'image',
 278             'urls' => [
 279                 'thumbnail' => $game->discover,
 280                 'full'      => $game->discover,
 281             ],
 282         ];
 283     }
 284     foreach ($game->media as $medium) {
 285         if ($medium->type == 'image')  {
 286             $mediaTiles[] = [
 287                 'type' => 'image',
 288                 'urls' => [
 289                     'thumbnail' => $medium->thumb,
 290                     'full'      => $medium->url,
 291                 ],
 292             ];
 293         } else {
 294             $mediaTiles[] = [
 295                 'type' => 'video',
 296                 'url'  => $medium->url,
 297             ];
 298         }
 299     }
 300
 301     $buttons = [];
 302     if (isset($game->links->unlocked)) {
 303         $buttons[] = [
 304             'text' => 'Show unlocked',
 305             'url'  => 'ouya://launcher/details?app=' . $game->links->unlocked,
 306             'bold' => true,
 307         ];
 308     }
 309
 310     // http://cweiske.de/ouya-store-api-docs.htm#get-https-devs-ouya-tv-api-v1-details
 311     return [
 312         'type'             => 'Game',
 313         'title'            => $game->title,
 314         'description'      => $game->description,
 315         'gamerNumbers'     => $game->players,
 316         'genres'           => $game->genres,
 317
 318         'suggestedAge'     => $game->contentRating,
 319         'premium'          => $game->premium,
 320         'inAppPurchases'   => $game->inAppPurchases,
 321         'firstPublishedAt' => strtotime($game->firstPublishedAt),
 322         'ccUrl'            => null,
 323
 324         'rating' => [
 325             'count'   => $game->rating->count,
 326             'average' => $game->rating->average,
 327         ],
 328
 329         'apk' => [
 330             'fileSize'    => $latestRelease->size,
 331             'nativeSize'  => $latestRelease->nativeSize,
 332             'publicSize'  => $latestRelease->publicSize,
 333             'md5sum'      => $latestRelease->md5sum,
 334             'filename'    => 'FIXME',
 335             'errors'      => '',
 336             'package'     => $game->packageName,
 337             'versionCode' => $latestRelease->versionCode,
 338             'state'       => 'complete',
 339         ],
 340
 341         'version' => [
 342             'number'      => $latestRelease->name,
 343             'publishedAt' => strtotime($latestRelease->date),
 344             'uuid'        => $latestRelease->uuid,
 345         ],
 346
 347         'developer' => [
 348             'name'    => $game->developer->name,
 349             'founder' => $game->developer->founder,
 350         ],
 351
 352         'metaData' => [
 353             'key:rating.average',
 354             'key:developer.name',
 355             'key:suggestedAge',
 356             number_format($latestRelease->size / 1024 / 1024, 2, '.', '') . ' MiB',
 357         ],
 358
 359         'tileImage'     => $game->discover,
 360         'mediaTiles'    => $mediaTiles,
 361         'mobileAppIcon' => null,
 362         'heroImage'     => [
 363             'url' => null,
 364         ],
 365
 366         'promotedProduct' => null,
 367         'buttons'         => $buttons,
 368     ];
 369 }
 370
 371 function addChunkedDiscoverRows(&$data, $games, $title)
 372 {
 373     $chunks = array_chunk($games, 4);
 374     $first = true;
 375     foreach ($chunks as $chunk) {
 376         addDiscoverRow(
 377             $data, $first ? $title : '',
 378             $chunk
 379         );
 380         $first = false;
 381     }
 382 }
 383
 384 function addDiscoverRow(&$data, $title, $games)
 385 {
 386     $row = [
 387         'title'     => $title,
 388         'showPrice' => false,
 389         'ranked'    => false,
 390         'tiles'     => [],
 391     ];
 392     foreach ($games as $game) {
 393         if (is_string($game)) {
 394             //category link
 395             $tilePos = count($data['tiles']);
 396             $data['tiles'][$tilePos] = buildDiscoverCategoryTile($game);
 397
 398         } else {
 399             //game
 400             if (isset($game->links->original)) {
 401                 //do not link unlocked games.
 402                 // people an access them via the original games
 403                 continue;
 404             }
 405             $tilePos = findTile($data['tiles'], $game->packageName);
 406             if ($tilePos === null) {
 407                 $tilePos = count($data['tiles']);
 408                 $data['tiles'][$tilePos] = buildDiscoverGameTile($game);
 409             }
 410         }
 411         $row['tiles'][] = $tilePos;
 412     }
 413     $data['rows'][] = $row;
 414 }
 415
 416 function findTile($tiles, $packageName)
 417 {
 418     foreach ($tiles as $pos => $tile) {
 419         if ($tile['package'] == $packageName) {
 420             return $pos;
 421         }
 422     }
 423     return null;
 424 }
 425
 426 function buildDiscoverCategoryTile($title)
 427 {
 428     return [
 429         'url'   => 'ouya://launcher/discover/' . categoryPath($title),
 430         'image' => '',
 431         'title' => $title,
 432         'type'  => 'discover'
 433     ];
 434 }
 435
 436 function buildDiscoverGameTile($game)
 437 {
 438     $latestRelease = $game->latestRelease;
 439     return [
 440         'gamerNumbers' => $game->players,
 441         'genres' => $game->genres,
 442         'url' => 'ouya://launcher/details?app=' . $game->packageName,
 443         'latestVersion' => [
 444             'apk' => [
 445                 'md5sum' => $latestRelease->md5sum,
 446             ],
 447             'versionNumber' => $latestRelease->name,
 448             'uuid' => $latestRelease->uuid,
 449         ],
 450         'inAppPurchases' => $game->inAppPurchases,
 451         'promotedProduct' => null,
 452         'premium' => $game->premium,
 453         'type' => 'app',
 454         'package' => $game->packageName,
 455         'updated_at' => strtotime($latestRelease->date),
 456         'updatedAt' => $latestRelease->date,
 457         'title' => $game->title,
 458         'image' => $game->discover,
 459         'contentRating' => $game->contentRating,
 460         'rating' => [
 461             'count' => $game->rating->count,
 462             'average' => $game->rating->average,
 463         ],
 464     ];
 465 }
 466
 467 function categoryPath($title)
 468 {
 469     return str_replace(['/', '\\', ' ', '+'], '_', $title);
 470 }
 471
 472 function getAllAges($games)
 473 {
 474     $ages = [];
 475     foreach ($games as $game) {
 476         $ages[] = $game->contentRating;
 477     }
 478     return array_unique($ages);
 479 }
 480
 481 function getAllGenres($games)
 482 {
 483     $genres = [];
 484     foreach ($games as $game) {
 485         $genres = array_merge($genres, $game->genres);
 486     }
 487     return array_unique($genres);
 488 }
 489
 490 function addMissingGameProperties($game)
 491 {
 492     if (!isset($game->overview)) {
 493         $game->overview = null;
 494     }
 495     if (!isset($game->description)) {
 496         $game->description = '';
 497     }
 498     if (!isset($game->players)) {
 499         $game->players = [1];
 500     }
 501     if (!isset($game->genres)) {
 502         $game->genres = ['Unsorted'];
 503     }
 504     if (!isset($game->website)) {
 505         $game->website = null;
 506     }
 507     if (!isset($game->contentRating)) {
 508         $game->contentRating = 'Everyone';
 509     }
 510     if (!isset($game->premium)) {
 511         $game->premium = false;
 512     }
 513     if (!isset($game->firstPublishedAt)) {
 514         $game->firstPublishedAt = gmdate('c');
 515     }
 516
 517     if (!isset($game->rating)) {
 518         $game->rating = new stdClass();
 519     }
 520     if (!isset($game->rating->likeCount)) {
 521         $game->rating->likeCount = 0;
 522     }
 523     if (!isset($game->rating->average)) {
 524         $game->rating->average = 0;
 525     }
 526     if (!isset($game->rating->count)) {
 527         $game->rating->count = 0;
 528     }
 529
 530     $game->latestRelease = null;
 531     $latestReleaseTimestamp = 0;
 532     foreach ($game->releases as $release) {
 533         if (!isset($release->publicSize)) {
 534             $release->publicSize = 0;
 535         }
 536         if (!isset($release->nativeSize)) {
 537             $release->nativeSize = 0;
 538         }
 539
 540         $releaseTimestamp = strtotime($release->date);
 541         if ($releaseTimestamp > $latestReleaseTimestamp) {
 542             $game->latestRelease    = $release;
 543             $latestReleaseTimestamp = $releaseTimestamp;
 544         }
 545     }
 546     if ($game->latestRelease === null) {
 547         error('No latest release for ' . $game->packageName);
 548     }
 549
 550     if (!isset($game->media)) {
 551         $game->media = [];
 552     }
 553
 554     if (!isset($game->developer->uuid)) {
 555         $game->developer->uuid = null;
 556     }
 557     if (!isset($game->developer->name)) {
 558         $game->developer->name = 'unknown';
 559     }
 560     if (!isset($game->developer->supportEmail)) {
 561         $game->developer->supportEmail = null;
 562     }
 563     if (!isset($game->developer->supportPhone)) {
 564         $game->developer->supportPhone = null;
 565     }
 566     if (!isset($game->developer->founder)) {
 567         $game->developer->founder = false;
 568     }
 569 }
 570
 571 function getFirstVideoUrl($media)
 572 {
 573     foreach ($media as $medium) {
 574         if ($medium->type == 'video') {
 575             return $medium->url;
 576         }
 577     }
 578     return null;
 579 }
 580
 581 function getAllImageUrls($media)
 582 {
 583     $imageUrls = [];
 584     foreach ($media as $medium) {
 585         if ($medium->type == 'image') {
 586             $imageUrls[] = $medium->url;
 587         }
 588     }
 589     return $imageUrls;
 590 }
 591
 592 function writeJson($path, $data)
 593 {
 594     global $wwwDir;
 595     $fullPath = $wwwDir . $path;
 596     $dir = dirname($fullPath);
 597     if (!is_dir($dir)) {
 598         mkdir($dir, 0777, true);
 599     }
 600     file_put_contents(
 601         $fullPath,
 602         json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) . "\n"
 603     );
 604 }
 605
 606 function error($msg)
 607 {
 608     fwrite(STDERR, $msg . "\n");
 609     exit(1);
 610 }
 611 ?>