test/test_youtube_signature.py

   1 #!/usr/bin/env python3
   2
   3 # Allow direct execution
   4 import os
   5 import sys
   6 import unittest
   7
   8 sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
   9
  10
  11 import contextlib
  12 import re
  13 import string
  14 import urllib.request
  15
  16 from test.helper import FakeYDL, is_download_test
  17 from yt_dlp.extractor import YoutubeIE
  18 from yt_dlp.jsinterp import JSInterpreter
  19
  20 _SIG_TESTS = [
  21     (
  22         'https://s.ytimg.com/yts/jsbin/html5player-vflHOr_nV.js',
  23         86,
  24         '>=<;:/.-[+*)(\'&%$#"!ZYX0VUTSRQPONMLKJIHGFEDCBA\\yxwvutsrqponmlkjihgfedcba987654321',
  25     ),
  26     (
  27         'https://s.ytimg.com/yts/jsbin/html5player-vfldJ8xgI.js',
  28         85,
  29         '3456789a0cdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRS[UVWXYZ!"#$%&\'()*+,-./:;<=>?@',
  30     ),
  31     (
  32         'https://s.ytimg.com/yts/jsbin/html5player-vfle-mVwz.js',
  33         90,
  34         ']\\[@?>=<;:/.-,+*)(\'&%$#"hZYXWVUTSRQPONMLKJIHGFEDCBAzyxwvutsrqponmlkjiagfedcb39876',
  35     ),
  36     (
  37         'https://s.ytimg.com/yts/jsbin/html5player-en_US-vfl0Cbn9e.js',
  38         84,
  39         'O1I3456789abcde0ghijklmnopqrstuvwxyzABCDEFGHfJKLMN2PQRSTUVW@YZ!"#$%&\'()*+,-./:;<=',
  40     ),
  41     (
  42         'https://s.ytimg.com/yts/jsbin/html5player-en_US-vflXGBaUN.js',
  43         '2ACFC7A61CA478CD21425E5A57EBD73DDC78E22A.2094302436B2D377D14A3BBA23022D023B8BC25AA',
  44         'A52CB8B320D22032ABB3A41D773D2B6342034902.A22E87CDD37DBE75A5E52412DC874AC16A7CFCA2',
  45     ),
  46     (
  47         'https://s.ytimg.com/yts/jsbin/html5player-en_US-vflBb0OQx.js',
  48         84,
  49         '123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQ0STUVWXYZ!"#$%&\'()*+,@./:;<=>'
  50     ),
  51     (
  52         'https://s.ytimg.com/yts/jsbin/html5player-en_US-vfl9FYC6l.js',
  53         83,
  54         '123456789abcdefghijklmnopqr0tuvwxyzABCDETGHIJKLMNOPQRS>UVWXYZ!"#$%&\'()*+,-./:;<=F'
  55     ),
  56     (
  57         'https://s.ytimg.com/yts/jsbin/html5player-en_US-vflCGk6yw/html5player.js',
  58         '4646B5181C6C3020DF1D9C7FCFEA.AD80ABF70C39BD369CCCAE780AFBB98FA6B6CB42766249D9488C288',
  59         '82C8849D94266724DC6B6AF89BBFA087EACCD963.B93C07FBA084ACAEFCF7C9D1FD0203C6C1815B6B'
  60     ),
  61     (
  62         'https://s.ytimg.com/yts/jsbin/html5player-en_US-vflKjOTVq/html5player.js',
  63         '312AA52209E3623129A412D56A40F11CB0AF14AE.3EE09501CB14E3BCDC3B2AE808BF3F1D14E7FBF12',
  64         '112AA5220913623229A412D56A40F11CB0AF14AE.3EE0950FCB14EEBCDC3B2AE808BF331D14E7FBF3',
  65     )
  66 ]
  67
  68 _NSIG_TESTS = [
  69     (
  70         'https://www.youtube.com/s/player/9216d1f7/player_ias.vflset/en_US/base.js',
  71         'SLp9F5bwjAdhE9F-', 'gWnb9IK2DJ8Q1w',
  72     ),
  73     (
  74         'https://www.youtube.com/s/player/f8cb7a3b/player_ias.vflset/en_US/base.js',
  75         'oBo2h5euWy6osrUt', 'ivXHpm7qJjJN',
  76     ),
  77     (
  78         'https://www.youtube.com/s/player/2dfe380c/player_ias.vflset/en_US/base.js',
  79         'oBo2h5euWy6osrUt', '3DIBbn3qdQ',
  80     ),
  81     (
  82         'https://www.youtube.com/s/player/f1ca6900/player_ias.vflset/en_US/base.js',
  83         'cu3wyu6LQn2hse', 'jvxetvmlI9AN9Q',
  84     ),
  85     (
  86         'https://www.youtube.com/s/player/8040e515/player_ias.vflset/en_US/base.js',
  87         'wvOFaY-yjgDuIEg5', 'HkfBFDHmgw4rsw',
  88     ),
  89     (
  90         'https://www.youtube.com/s/player/e06dea74/player_ias.vflset/en_US/base.js',
  91         'AiuodmaDDYw8d3y4bf', 'ankd8eza2T6Qmw',
  92     ),
  93     (
  94         'https://www.youtube.com/s/player/5dd88d1d/player-plasma-ias-phone-en_US.vflset/base.js',
  95         'kSxKFLeqzv_ZyHSAt', 'n8gS8oRlHOxPFA',
  96     ),
  97     (
  98         'https://www.youtube.com/s/player/324f67b9/player_ias.vflset/en_US/base.js',
  99         'xdftNy7dh9QGnhW', '22qLGxrmX8F1rA',
 100     ),
 101     (
 102         'https://www.youtube.com/s/player/4c3f79c5/player_ias.vflset/en_US/base.js',
 103         'TDCstCG66tEAO5pR9o', 'dbxNtZ14c-yWyw',
 104     ),
 105     (
 106         'https://www.youtube.com/s/player/c81bbb4a/player_ias.vflset/en_US/base.js',
 107         'gre3EcLurNY2vqp94', 'Z9DfGxWP115WTg',
 108     ),
 109     (
 110         'https://www.youtube.com/s/player/1f7d5369/player_ias.vflset/en_US/base.js',
 111         'batNX7sYqIJdkJ', 'IhOkL_zxbkOZBw',
 112     ),
 113     (
 114         'https://www.youtube.com/s/player/009f1d77/player_ias.vflset/en_US/base.js',
 115         '5dwFHw8aFWQUQtffRq', 'audescmLUzI3jw',
 116     ),
 117     (
 118         'https://www.youtube.com/s/player/dc0c6770/player_ias.vflset/en_US/base.js',
 119         '5EHDMgYLV6HPGk_Mu-kk', 'n9lUJLHbxUI0GQ',
 120     ),
 121     (
 122         'https://www.youtube.com/s/player/113ca41c/player_ias.vflset/en_US/base.js',
 123         'cgYl-tlYkhjT7A', 'hI7BBr2zUgcmMg',
 124     ),
 125 ]
 126
 127
 128 @is_download_test
 129 class TestPlayerInfo(unittest.TestCase):
 130     def test_youtube_extract_player_info(self):
 131         PLAYER_URLS = (
 132             ('https://www.youtube.com/s/player/4c3f79c5/player_ias.vflset/en_US/base.js', '4c3f79c5'),
 133             ('https://www.youtube.com/s/player/64dddad9/player_ias.vflset/en_US/base.js', '64dddad9'),
 134             ('https://www.youtube.com/s/player/64dddad9/player_ias.vflset/fr_FR/base.js', '64dddad9'),
 135             ('https://www.youtube.com/s/player/64dddad9/player-plasma-ias-phone-en_US.vflset/base.js', '64dddad9'),
 136             ('https://www.youtube.com/s/player/64dddad9/player-plasma-ias-phone-de_DE.vflset/base.js', '64dddad9'),
 137             ('https://www.youtube.com/s/player/64dddad9/player-plasma-ias-tablet-en_US.vflset/base.js', '64dddad9'),
 138             # obsolete
 139             ('https://www.youtube.com/yts/jsbin/player_ias-vfle4-e03/en_US/base.js', 'vfle4-e03'),
 140             ('https://www.youtube.com/yts/jsbin/player_ias-vfl49f_g4/en_US/base.js', 'vfl49f_g4'),
 141             ('https://www.youtube.com/yts/jsbin/player_ias-vflCPQUIL/en_US/base.js', 'vflCPQUIL'),
 142             ('https://www.youtube.com/yts/jsbin/player-vflzQZbt7/en_US/base.js', 'vflzQZbt7'),
 143             ('https://www.youtube.com/yts/jsbin/player-en_US-vflaxXRn1/base.js', 'vflaxXRn1'),
 144             ('https://s.ytimg.com/yts/jsbin/html5player-en_US-vflXGBaUN.js', 'vflXGBaUN'),
 145             ('https://s.ytimg.com/yts/jsbin/html5player-en_US-vflKjOTVq/html5player.js', 'vflKjOTVq'),
 146         )
 147         for player_url, expected_player_id in PLAYER_URLS:
 148             player_id = YoutubeIE._extract_player_info(player_url)
 149             self.assertEqual(player_id, expected_player_id)
 150
 151
 152 @is_download_test
 153 class TestSignature(unittest.TestCase):
 154     def setUp(self):
 155         TEST_DIR = os.path.dirname(os.path.abspath(__file__))
 156         self.TESTDATA_DIR = os.path.join(TEST_DIR, 'testdata/sigs')
 157         if not os.path.exists(self.TESTDATA_DIR):
 158             os.mkdir(self.TESTDATA_DIR)
 159
 160     def tearDown(self):
 161         with contextlib.suppress(OSError):
 162             for f in os.listdir(self.TESTDATA_DIR):
 163                 os.remove(f)
 164
 165
 166 def t_factory(name, sig_func, url_pattern):
 167     def make_tfunc(url, sig_input, expected_sig):
 168         m = url_pattern.match(url)
 169         assert m, '%r should follow URL format' % url
 170         test_id = m.group('id')
 171
 172         def test_func(self):
 173             basename = f'player-{name}-{test_id}.js'
 174             fn = os.path.join(self.TESTDATA_DIR, basename)
 175
 176             if not os.path.exists(fn):
 177                 urllib.request.urlretrieve(url, fn)
 178             with open(fn, encoding='utf-8') as testf:
 179                 jscode = testf.read()
 180             self.assertEqual(sig_func(jscode, sig_input), expected_sig)
 181
 182         test_func.__name__ = f'test_{name}_js_{test_id}'
 183         setattr(TestSignature, test_func.__name__, test_func)
 184     return make_tfunc
 185
 186
 187 def signature(jscode, sig_input):
 188     func = YoutubeIE(FakeYDL())._parse_sig_js(jscode)
 189     src_sig = (
 190         str(string.printable[:sig_input])
 191         if isinstance(sig_input, int) else sig_input)
 192     return func(src_sig)
 193
 194
 195 def n_sig(jscode, sig_input):
 196     funcname = YoutubeIE(FakeYDL())._extract_n_function_name(jscode)
 197     return JSInterpreter(jscode).call_function(funcname, sig_input)
 198
 199
 200 make_sig_test = t_factory(
 201     'signature', signature, re.compile(r'.*-(?P<id>[a-zA-Z0-9_-]+)(?:/watch_as3|/html5player)?\.[a-z]+$'))
 202 for test_spec in _SIG_TESTS:
 203     make_sig_test(*test_spec)
 204
 205 make_nsig_test = t_factory(
 206     'nsig', n_sig, re.compile(r'.+/player/(?P<id>[a-zA-Z0-9_-]+)/.+.js$'))
 207 for test_spec in _NSIG_TESTS:
 208     make_nsig_test(*test_spec)
 209
 210
 211 if __name__ == '__main__':
 212     unittest.main()