ops-Gazelle/tests/phpunit/DownloadTest.php

<?php

namespace Gazelle;

use PHPUnit\Framework\TestCase;
use GazelleUnitTest\Helper;
use Gazelle\Enum\DownloadStatus;

class DownloadTest extends TestCase {
    protected Torrent $torrent;
    protected array $userList;

    public function setUp(): void {
        $this->userList = [
            'up'   => Helper::makeUser('upload.' . randomString(6), 'download'),
            'down' => Helper::makeUser('download.' . randomString(6), 'download'),
        ];
        $this->userList['up']->requestContext()->setViewer($this->userList['up']);
        $this->torrent = Helper::makeTorrentMusic(
            tgroup: Helper::makeTGroupMusic(
                name:       'phpunit download ' . randomString(6),
                artistName: [[ARTIST_MAIN], ['the ' . randomString(12) . ' Band']],
                tagName:    ['downtempo'],
                user:       $this->userList['up'],
            ),
            user: $this->userList['up'],
            size: (int)(BYTES_PER_FREELEECH_TOKEN * 2.5), // need three tokens to play
        );
    }

    public function tearDown(): void {
        Helper::removeTGroup($this->torrent->group(), $this->torrent->uploader());
        $db = DB::DB();
        foreach ($this->userList as $user) {
            $db->scalar("DELETE FROM ratelimit_torrent WHERE user_id = ?", $user->id);
            $user->remove();
        }
    }

    public function testBasic(): void {
        $user     = $this->userList['up'];
        $uploader = new Download($this->torrent, new User\UserclassRateLimit($user), false);
        $this->assertEquals(DownloadStatus::ok, $uploader->status(), 'download-uploader-ok');
        $this->assertEquals(1, $this->torrent->downloadTotal(), 'download-torrent-total');
        $this->assertEquals(1, $user->torrentDownloadCount($this->torrent), 'user-torrent-download-count');
        $list = $this->torrent->downloadList($user, 2, 0);
        $this->assertCount(1, $list, 'download-torrent-list');
        $this->assertEquals(
            ['user_id', 'timestamp_min', 'timestamp_max', 'is_seeding', 'is_snatched', 'total'],
            array_keys($list[0]),
            'download-torrent-keys'
        );
        Helper::generateTorrentSeed($this->torrent, $user);
        $list = $this->torrent->seederList($user, 2, 0);
        $this->assertCount(1, $list, 'seeder-torrent-list');
        $this->assertEquals(
            ['active', 'connectable', 'remaining', 'uploaded', 'useragent',
                'ipv4addr', 'user_id', 'size', 'seedbox', 'is_download', 'is_snatched'],
            array_keys($list[0]),
            'snatch-torrent-keys'
        );
        // torrent snatch list is handled in another test

        $ratelimit = new User\UserclassRateLimit($this->userList['down']);
        $this->assertFalse(
            is_nan($ratelimit->userclassFactor()),
            'download-ratelimit-userclass-factor',
        );
        $this->assertTrue(is_nan($ratelimit->userFactor()), 'download-ratelimit-user-factor');
        $this->assertFalse($ratelimit->hasExceededFactor(), 'download-ratelimit-factor');
        $this->assertFalse($ratelimit->hasExceededTotal(), 'download-ratelimit-total');
        $downloader = new Download($this->torrent, $ratelimit, false);
        $this->assertEquals(DownloadStatus::ok, $downloader->status(), 'download-downloader-ok');
        $this->assertGreaterThan(0, $ratelimit->register($this->torrent), 'download-register-ratelimit');

        $this->userList['down']->setField('can_leech', 0)->modify();
        $ratio = new Download($this->torrent, new User\UserclassRateLimit($this->userList['down']), false);
        $this->assertEquals(DownloadStatus::ratio, $ratio->status(), 'download-downloader-ratio-watch');
    }

    public function testFreeleech(): void {
        $none = new Download($this->torrent, new User\UserclassRateLimit($this->userList['down']), true);
        $this->assertEquals(DownloadStatus::too_big, $none->status(), 'download-downloader-no-tokens');

        $this->userList['down']->updateTokens(2);
        $some = new Download($this->torrent, new User\UserclassRateLimit($this->userList['down']), true);
        $this->assertEquals(DownloadStatus::too_big, $some->status(), 'download-downloader-some-tokens');
        $this->assertFalse($this->torrent->isFreeleechPersonal(), 'download-downloader-not-yet-free');

        $this->userList['down']->updateTokens(4);
        $enough = new Download($this->torrent, new User\UserclassRateLimit($this->userList['down']), true);
        $this->assertEquals(DownloadStatus::ok, $enough->status(), 'download-downloader-enough-tokens');

        $this->assertEquals(1, $this->userList['down']->tokenCount(), 'download-downloader-spent-tokens');
        $this->assertTrue($this->userList['down']->hasToken($this->torrent), 'download-downloader-is-free');
        $this->assertTrue(
            $this->torrent->flush()->setViewer($this->userList['down'])->isFreeleechPersonal(),
            'download-torrent-is-free-personal'
        );
    }

    public function testRedownload(): void {
        $user = $this->userList['down'];
        $user->updateTokens(10);
        $limiter = new User\UserclassRateLimit($user);
        $initial = new Download($this->torrent, $limiter, true);

        // download with token
        $this->assertEquals(DownloadStatus::ok, $initial->status(), 'redown-initial');
        $this->assertTrue($user->hasToken($this->torrent), 'redown-user-has-token');

        // time goes by and the user downloads the torrent
        Helper::generateTorrentSnatch($this->torrent, $user);
        $this->assertEquals(1, $this->torrent->expireToken($user), 'redown-expire-token');
        $this->assertFalse($user->flush()->hasToken($this->torrent), 'redown-user-no-more-token');
        $this->assertFalse($this->torrent->isFreeleechPersonal(), 'redown-torrent-is-not-pfl');
        $tracker = $user->history()->trackerIPv4();
        $this->assertCount(1, $tracker, 'tracker-history-total');
        $this->assertEquals('127.0.0.1', $tracker[0]['ipv4'], 'tracker-history-ipv4');

        $list = $this->torrent->snatchList($user, 2, 0);
        $this->assertCount(1, $list, 'snatch-torrent-list');
        $this->assertEquals(
            ['user_id', 'timestamp', 'is_download', 'is_seeding'],
            array_keys($list[0]),
            'snatch-torrent-keys'
        );

        // download again without token
        $redownload = new Download($this->torrent, $limiter, false);
        $this->assertEquals(DownloadStatus::ok, $redownload->status(), 'redown-redownload');
        $this->assertFalse($this->torrent->isFreeleechPersonal(), 'redown-torrent-is-still-not-pfl');

        (new Stats\Users())->refresh();
        $this->assertEquals(2, $user->stats()->downloadTotal(), 'redown-user-download-total');
        $this->assertEquals(1, $user->stats()->downloadUnique(), 'redown-user-download-unique');

        $this->assertEquals(2, $user->history()->resetDownloaded(), 'redown-reset-downloaded');
        $this->assertEquals(1, $user->history()->resetSnatched(), 'redown-reset-snatched');
        (new Stats\Users())->refresh();
        $this->assertEquals(
            0,
            $user->flush()->stats()->downloadTotal(),
            'redown-user-reset-download-total'
        );
    }

    public function testRecentTotal(): void {
        $user = $this->userList['down'];
        $tstats = new Stats\Torrent();
        $initial = $tstats->recentDownloadTotal();
        $this->assertCount(3, $initial, 'down-stats-recent-initial');

        $download = new Download($this->torrent, new User\UserclassRateLimit($user), false);
        $this->assertEquals(DownloadStatus::ok, $download->status(), 'down-stats-ok');
        $current = $tstats->recentDownloadTotal();
        $this->assertEquals($initial[0]['total'] + 1, $current[0]['total'], 'down-stats-increment');

        // there will be one user (or more) in the past day
        $ustats = new Stats\Users();
        $recent = $ustats->topTotalDownloadList(1, 1);
        $this->assertCount(1, $recent, 'down-stats-top-user');
        $this->assertEquals(
            ["total", "user_id", "limited", "disabled"],
            array_keys($recent[0]),
            'down-stats-user-keys'
        );
    }
}