Merge 9de472f6ea into be3579aaf0

Authored by: stratus-ss, bashonly

Co-authored-by: bashonly <88596187+bashonly@users.noreply.github.com>

README.md

@@ -612,8 +612,7 @@ If you fork the project on GitHub, you can run your fork's [build workflow](.git
     --no-restrict-filenames         Allow Unicode characters, "&" and spaces in
                                     filenames (default)
     --windows-filenames             Force filenames to be Windows-compatible
-    --no-windows-filenames          Make filenames Windows-compatible only if
-                                    using Windows (default)
+    --no-windows-filenames          Sanitize filenames only minimally
     --trim-filenames LENGTH         Limit the filename length (excluding
                                     extension) to the specified number of
                                     characters

test/test_YoutubeDL.py

@@ -762,6 +762,13 @@ class TestYoutubeDL(unittest.TestCase):
         test('%(width)06d.%%(ext)s', 'NA.%(ext)s')
         test('%%(width)06d.%(ext)s', '%(width)06d.mp4')
 
+        # Sanitization options
+        test('%(title3)s', (None, 'foo⧸bar⧹test'))
+        test('%(title5)s', (None, 'aei_A'), restrictfilenames=True)
+        test('%(title3)s', (None, 'foo_bar_test'), windowsfilenames=False, restrictfilenames=True)
+        if sys.platform != 'win32':
+            test('%(title3)s', (None, 'foo⧸bar\\test'), windowsfilenames=False)
+
         # ID sanitization
         test('%(id)s', '_abcd', info={'id': '_abcd'})
         test('%(some_id)s', '_abcd', info={'some_id': '_abcd'})

yt_dlp/YoutubeDL.py

@@ -267,7 +267,9 @@ class YoutubeDL:
     outtmpl_na_placeholder: Placeholder for unavailable meta fields.
     restrictfilenames: Do not allow "&" and spaces in file names
     trim_file_name:    Limit length of filename (extension excluded)
-    windowsfilenames:  Force the filenames to be windows compatible
+    windowsfilenames:  True: Force filenames to be Windows compatible
+                       False: Sanitize filenames only minimally
+                       This option has no effect when running on Windows
     ignoreerrors:      Do not stop on download/postprocessing errors.
                        Can be 'only_download' to ignore only download errors.
                        Default is 'only_download' for CLI, but False for API
@@ -1193,8 +1195,7 @@ class YoutubeDL:
 
     def prepare_outtmpl(self, outtmpl, info_dict, sanitize=False):
         """ Make the outtmpl and info_dict suitable for substitution: ydl.escape_outtmpl(outtmpl) % info_dict
-        @param sanitize    Whether to sanitize the output as a filename.
-                           For backward compatibility, a function can also be passed
+        @param sanitize    Whether to sanitize the output as a filename
         """
 
         info_dict.setdefault('epoch', int(time.time()))  # keep epoch consistent once set
@@ -1310,14 +1311,23 @@ class YoutubeDL:
 
         na = self.params.get('outtmpl_na_placeholder', 'NA')
 
-        def filename_sanitizer(key, value, restricted=self.params.get('restrictfilenames')):
+        def filename_sanitizer(key, value, restricted):
             return sanitize_filename(str(value), restricted=restricted, is_id=(
                 bool(re.search(r'(^|[_.])id(\.|$)', key))
                 if 'filename-sanitization' in self.params['compat_opts']
                 else NO_DEFAULT))
 
-        sanitizer = sanitize if callable(sanitize) else filename_sanitizer
-        sanitize = bool(sanitize)
+        if callable(sanitize):
+            self.deprecation_warning('Passing a callable "sanitize" to YoutubeDL.prepare_outtmpl is deprecated')
+        elif not sanitize:
+            pass
+        elif (sys.platform != 'win32' and not self.params.get('restrictfilenames')
+                and self.params.get('windowsfilenames') is False):
+            def sanitize(key, value):
+                return value.replace('/', '\u29F8').replace('\0', '')
+        else:
+            def sanitize(key, value):
+                return filename_sanitizer(key, value, restricted=self.params.get('restrictfilenames'))
 
         def _dumpjson_default(obj):
             if isinstance(obj, (set, LazyList)):
@@ -1400,13 +1410,13 @@ class YoutubeDL:
 
             if sanitize:
                 # If value is an object, sanitize might convert it to a string
-                # So we convert it to repr first
+                # So we manually convert it before sanitizing
                 if fmt[-1] == 'r':
                     value, fmt = repr(value), str_fmt
                 elif fmt[-1] == 'a':
                     value, fmt = ascii(value), str_fmt
                 if fmt[-1] in 'csra':
-                    value = sanitizer(last_field, value)
+                    value = sanitize(last_field, value)
 
             key = '{}\0{}'.format(key.replace('%', '%\0'), outer_mobj.group('format'))
             TMPL_DICT[key] = value

yt_dlp/extractor/_extractors.py

@@ -708,6 +708,7 @@ from .gab import (
     GabTVIE,
 )
 from .gaia import GaiaIE
+from .gamedevtv import GameDevTVDashboardIE
 from .gamejolt import (
     GameJoltCommunityIE,
     GameJoltGameIE,

yt_dlp/extractor/adobepass.py

@@ -1362,7 +1362,7 @@ class AdobePassIE(InfoExtractor):  # XXX: Conventionally, base classes should en
 
     def _download_webpage_handle(self, *args, **kwargs):
         headers = self.geo_verification_headers()
-        headers.update(kwargs.get('headers', {}))
+        headers.update(kwargs.get('headers') or {})
         kwargs['headers'] = headers
         return super()._download_webpage_handle(
             *args, **kwargs)

yt_dlp/extractor/gamedevtv.py

@@ -0,0 +1,141 @@
+import json
+
+from .common import InfoExtractor
+from ..networking.exceptions import HTTPError
+from ..utils import (
+    ExtractorError,
+    clean_html,
+    int_or_none,
+    join_nonempty,
+    parse_iso8601,
+    str_or_none,
+    url_or_none,
+)
+from ..utils.traversal import traverse_obj
+
+
+class GameDevTVDashboardIE(InfoExtractor):
+    _VALID_URL = r'https?://(?:www\.)?gamedev\.tv/dashboard/courses/(?P<course_id>\d+)(?:/(?P<lecture_id>\d+))?'
+    _NETRC_MACHINE = 'gamedevtv'
+    _TESTS = [{
+        'url': 'https://www.gamedev.tv/dashboard/courses/25',
+        'info_dict': {
+            'id': '25',
+            'title': 'Complete Blender Creator 3: Learn 3D Modelling for Beginners',
+            'tags': ['blender', 'course', 'all', 'box modelling', 'sculpting'],
+            'categories': ['Blender', '3D Art'],
+            'thumbnail': 'https://gamedev-files.b-cdn.net/courses/qisc9pmu1jdc.jpg',
+            'upload_date': '20220516',
+            'timestamp': 1652694420,
+            'modified_date': '20241027',
+            'modified_timestamp': 1730049658,
+        },
+        'playlist_count': 100,
+    }, {
+        'url': 'https://www.gamedev.tv/dashboard/courses/63/2279',
+        'info_dict': {
+            'id': 'df04f4d8-68a4-4756-a71b-9ca9446c3a01',
+            'ext': 'mp4',
+            'modified_timestamp': 1701695752,
+            'upload_date': '20230504',
+            'episode': 'MagicaVoxel Community Course Introduction',
+            'series_id': '63',
+            'title': 'MagicaVoxel Community Course Introduction',
+            'timestamp': 1683195397,
+            'modified_date': '20231204',
+            'categories': ['3D Art', 'MagicaVoxel'],
+            'season': 'MagicaVoxel Community Course',
+            'tags': ['MagicaVoxel', 'all', 'course'],
+            'series': 'MagicaVoxel 3D Art Mini Course',
+            'duration': 1405,
+            'episode_number': 1,
+            'season_number': 1,
+            'season_id': '219',
+            'description': 'md5:a378738c5bbec1c785d76c067652d650',
+            'display_id': '63-219-2279',
+            'alt_title': '1_CC_MVX MagicaVoxel Community Course Introduction.mp4',
+            'thumbnail': 'https://vz-23691c65-6fa.b-cdn.net/df04f4d8-68a4-4756-a71b-9ca9446c3a01/thumbnail.jpg',
+        },
+    }]
+    _API_HEADERS = {}
+
+    def _perform_login(self, username, password):
+        try:
+            response = self._download_json(
+                'https://api.gamedev.tv/api/students/login', None, 'Logging in',
+                headers={'Content-Type': 'application/json'},
+                data=json.dumps({
+                    'email': username,
+                    'password': password,
+                    'cart_items': [],
+                }).encode())
+        except ExtractorError as e:
+            if isinstance(e.cause, HTTPError) and e.cause.status == 401:
+                raise ExtractorError('Invalid username/password', expected=True)
+            raise
+
+        self._API_HEADERS['Authorization'] = f'{response["token_type"]} {response["access_token"]}'
+
+    def _real_initialize(self):
+        if not self._API_HEADERS.get('Authorization'):
+            self.raise_login_required(
+                'This content is only available with purchase', method='password')
+
+    def _entries(self, data, course_id, course_info, selected_lecture):
+        for section in traverse_obj(data, ('sections', ..., {dict})):
+            section_info = traverse_obj(section, {
+                'season_id': ('id', {str_or_none}),
+                'season': ('title', {str}),
+                'season_number': ('order', {int_or_none}),
+            })
+            for lecture in traverse_obj(section, ('lectures', lambda _, v: url_or_none(v['video']['playListUrl']))):
+                if selected_lecture and str(lecture.get('id')) != selected_lecture:
+                    continue
+                display_id = join_nonempty(course_id, section_info.get('season_id'), lecture.get('id'))
+                formats, subtitles = self._extract_m3u8_formats_and_subtitles(
+                    lecture['video']['playListUrl'], display_id, 'mp4', m3u8_id='hls')
+                yield {
+                    **course_info,
+                    **section_info,
+                    'id': display_id,  # fallback
+                    'display_id': display_id,
+                    'formats': formats,
+                    'subtitles': subtitles,
+                    'series': course_info.get('title'),
+                    'series_id': course_id,
+                    **traverse_obj(lecture, {
+                        'id': ('video', 'guid', {str}),
+                        'title': ('title', {str}),
+                        'alt_title': ('video', 'title', {str}),
+                        'description': ('description', {clean_html}),
+                        'episode': ('title', {str}),
+                        'episode_number': ('order', {int_or_none}),
+                        'duration': ('video', 'duration_in_sec', {int_or_none}),
+                        'timestamp': ('video', 'created_at', {parse_iso8601}),
+                        'modified_timestamp': ('video', 'updated_at', {parse_iso8601}),
+                        'thumbnail': ('video', 'thumbnailUrl', {url_or_none}),
+                    }),
+                }
+
+    def _real_extract(self, url):
+        course_id, lecture_id = self._match_valid_url(url).group('course_id', 'lecture_id')
+        data = self._download_json(
+            f'https://api.gamedev.tv/api/courses/my/{course_id}', course_id,
+            headers=self._API_HEADERS)['data']
+
+        course_info = traverse_obj(data, {
+            'title': ('title', {str}),
+            'tags': ('tags', ..., 'name', {str}),
+            'categories': ('categories', ..., 'title', {str}),
+            'timestamp': ('created_at', {parse_iso8601}),
+            'modified_timestamp': ('updated_at', {parse_iso8601}),
+            'thumbnail': ('image', {url_or_none}),
+        })
+
+        entries = self._entries(data, course_id, course_info, lecture_id)
+        if lecture_id:
+            lecture = next(entries, None)
+            if not lecture:
+                raise ExtractorError('Lecture not found')
+            return lecture
+        return self.playlist_result(entries, course_id, **course_info)

yt_dlp/options.py

@@ -1368,12 +1368,12 @@ def create_parser():
         help='Allow Unicode characters, "&" and spaces in filenames (default)')
     filesystem.add_option(
         '--windows-filenames',
-        action='store_true', dest='windowsfilenames', default=False,
+        action='store_true', dest='windowsfilenames', default=None,
         help='Force filenames to be Windows-compatible')
     filesystem.add_option(
         '--no-windows-filenames',
         action='store_false', dest='windowsfilenames',
-        help='Make filenames Windows-compatible only if using Windows (default)')
+        help='Sanitize filenames only minimally')
     filesystem.add_option(
         '--trim-filenames', '--trim-file-names', metavar='LENGTH',
         dest='trim_file_name', default=0, type=int,