You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gallery-dl/gallery_dl/extractor/newgrounds.py

672 lines
24 KiB

# -*- coding: utf-8 -*-
# Copyright 2018-2023 Mike Fährmann
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
"""Extractors for https://www.newgrounds.com/"""
from .common import Extractor, Message
from .. import text, util, exception
from ..cache import cache
import itertools
class NewgroundsExtractor(Extractor):
"""Base class for newgrounds extractors"""
category = "newgrounds"
directory_fmt = ("{category}", "{artist[:10]:J, }")
filename_fmt = "{category}_{_index}_{title}.{extension}"
archive_fmt = "{_type}{_index}"
root = "https://www.newgrounds.com"
cookies_domain = ".newgrounds.com"
cookies_names = ("NG_GG_username", "vmk1du5I8m")
request_interval = 1.0
def __init__(self, match):
Extractor.__init__(self, match)
self.user = match.group(1)
self.user_root = "https://{}.newgrounds.com".format(self.user)
self.flash = self.config("flash", True)
fmt = self.config("format", "original")
self.format = (True if not fmt or fmt == "original" else
fmt if isinstance(fmt, int) else
text.parse_int(fmt.rstrip("p")))
def items(self):
self.login()
metadata = self.metadata()
for post_url in self.posts():
try:
post = self.extract_post(post_url)
url = post.get("url")
except Exception:
self.log.debug("", exc_info=True)
url = None
if url:
if metadata:
post.update(metadata)
yield Message.Directory, post
yield Message.Url, url, text.nameext_from_url(url, post)
for num, url in enumerate(text.extract_iter(
post["_comment"], 'data-smartload-src="', '"'), 1):
post["num"] = num
post["_index"] = "{}_{:>02}".format(post["index"], num)
url = text.ensure_http_scheme(url)
yield Message.Url, url, text.nameext_from_url(url, post)
else:
self.log.warning(
"Unable to get download URL for '%s'", post_url)
def posts(self):
"""Return URLs of all relevant post pages"""
return self._pagination(self._path)
def metadata(self):
"""Return general metadata"""
def login(self):
if self.cookies_check(self.cookies_names):
return
username, password = self._get_auth_info()
if username:
self.cookies_update(self._login_impl(username, password))
@cache(maxage=360*24*3600, keyarg=1)
def _login_impl(self, username, password):
self.log.info("Logging in as %s", username)
url = self.root + "/passport/"
response = self.request(url)
if response.history and response.url.endswith("/social"):
return self.cookies
page = response.text
headers = {"Origin": self.root, "Referer": url}
url = text.urljoin(self.root, text.extr(page, 'action="', '"'))
data = {
"username": username,
"password": password,
"remember": "1",
"login" : "1",
"auth" : text.extr(page, 'name="auth" value="', '"'),
}
response = self.request(url, method="POST", headers=headers, data=data)
if not response.history:
raise exception.AuthenticationError()
return {
cookie.name: cookie.value
for cookie in response.history[0].cookies
if cookie.expires and cookie.domain == self.cookies_domain
}
def extract_post(self, post_url):
url = post_url
if "/art/view/" in post_url:
extract_data = self._extract_image_data
elif "/audio/listen/" in post_url:
extract_data = self._extract_audio_data
else:
extract_data = self._extract_media_data
if self.flash:
url += "/format/flash"
with self.request(url, fatal=False) as response:
if response.status_code >= 400:
return {}
page = response.text
pos = page.find('id="adults_only"')
if pos >= 0:
msg = text.extract(page, 'class="highlight">', '<', pos)[0]
self.log.warning('"%s"', msg)
extr = text.extract_from(page)
data = extract_data(extr, post_url)
data["_comment"] = extr(
'id="author_comments"', '</div>').partition(">")[2]
data["comment"] = text.unescape(text.remove_html(
data["_comment"], "", ""))
data["favorites"] = text.parse_int(extr(
'id="faves_load">', '<').replace(",", ""))
data["score"] = text.parse_float(extr('id="score_number">', '<'))
data["tags"] = text.split_html(extr('<dd class="tags">', '</dd>'))
data["artist"] = [
text.extr(user, '//', '.')
for user in text.extract_iter(page, '<div class="item-user">', '>')
]
data["tags"].sort()
data["user"] = self.user or data["artist"][0]
data["post_url"] = post_url
return data
@staticmethod
def _extract_image_data(extr, url):
full = text.extract_from(util.json_loads(extr(
'"full_image_text":', '});')))
data = {
"title" : text.unescape(extr('"og:title" content="', '"')),
"description": text.unescape(extr(':description" content="', '"')),
"type" : extr('og:type" content="', '"'),
"_type" : "i",
"date" : text.parse_datetime(extr(
'itemprop="datePublished" content="', '"')),
"rating" : extr('class="rated-', '"'),
"url" : full('src="', '"'),
"width" : text.parse_int(full('width="', '"')),
"height" : text.parse_int(full('height="', '"')),
}
index = data["url"].rpartition("/")[2].partition("_")[0]
data["index"] = text.parse_int(index)
data["_index"] = index
return data
@staticmethod
def _extract_audio_data(extr, url):
index = url.split("/")[5]
return {
"title" : text.unescape(extr('"og:title" content="', '"')),
"description": text.unescape(extr(':description" content="', '"')),
"type" : extr('og:type" content="', '"'),
"_type" : "a",
"date" : text.parse_datetime(extr(
'itemprop="datePublished" content="', '"')),
"url" : extr('{"url":"', '"').replace("\\/", "/"),
"index" : text.parse_int(index),
"_index" : index,
"rating" : "",
}
def _extract_media_data(self, extr, url):
index = url.split("/")[5]
title = extr('"og:title" content="', '"')
type = extr('og:type" content="', '"')
descr = extr('"og:description" content="', '"')
src = extr('{"url":"', '"')
if src:
src = src.replace("\\/", "/")
fallback = ()
date = text.parse_datetime(extr(
'itemprop="datePublished" content="', '"'))
else:
url = self.root + "/portal/video/" + index
headers = {
"Accept": "application/json, text/javascript, */*; q=0.01",
"X-Requested-With": "XMLHttpRequest",
"Referer": self.root,
}
sources = self.request(url, headers=headers).json()["sources"]
if self.format is True:
src = sources["360p"][0]["src"].replace(".360p.", ".")
formats = sources
else:
formats = []
for fmt, src in sources.items():
width = text.parse_int(fmt.rstrip("p"))
if width <= self.format:
formats.append((width, src))
if formats:
formats.sort(reverse=True)
src, formats = formats[0][1][0]["src"], formats[1:]
else:
src = ""
fallback = self._video_fallback(formats)
date = text.parse_timestamp(src.rpartition("?")[2])
return {
"title" : text.unescape(title),
"url" : src,
"date" : date,
"type" : type,
"_type" : "",
"description": text.unescape(descr or extr(
'itemprop="description" content="', '"')),
"rating" : extr('class="rated-', '"'),
"index" : text.parse_int(index),
"_index" : index,
"_fallback" : fallback,
}
@staticmethod
def _video_fallback(formats):
if isinstance(formats, dict):
formats = list(formats.items())
formats.sort(key=lambda fmt: text.parse_int(fmt[0].rstrip("p")),
reverse=True)
for fmt in formats:
yield fmt[1][0]["src"]
def _pagination(self, kind):
url = "{}/{}".format(self.user_root, kind)
params = {
"page": 1,
"isAjaxRequest": "1",
}
headers = {
"Referer": url,
"X-Requested-With": "XMLHttpRequest",
}
while True:
with self.request(
url, params=params, headers=headers,
fatal=False) as response:
try:
data = response.json()
except ValueError:
return
if not data:
return
if "errors" in data:
msg = ", ".join(text.unescape(e) for e in data["errors"])
raise exception.StopExtraction(msg)
items = data.get("items")
if not items:
return
for year, items in items.items():
for item in items:
page_url = text.extr(item, 'href="', '"')
if page_url[0] == "/":
page_url = self.root + page_url
yield page_url
more = data.get("load_more")
if not more or len(more) < 8:
return
params["page"] += 1
class NewgroundsImageExtractor(NewgroundsExtractor):
"""Extractor for a single image from newgrounds.com"""
subcategory = "image"
pattern = (r"(?:https?://)?(?:"
r"(?:www\.)?newgrounds\.com/art/view/([^/?#]+)/[^/?#]+"
r"|art\.ngfiles\.com/images/\d+/\d+_([^_]+)_([^.]+))")
test = (
("https://www.newgrounds.com/art/view/tomfulp/ryu-is-hawt", {
"url": "57f182bcbbf2612690c3a54f16ffa1da5105245e",
"content": "8f395e08333eb2457ba8d8b715238f8910221365",
"keyword": {
"artist" : ["tomfulp"],
"comment" : "re:Consider this the bottom threshold for ",
"date" : "dt:2009-06-04 14:44:05",
"description": "re:Consider this the bottom threshold for ",
"favorites" : int,
"filename" : "94_tomfulp_ryu-is-hawt",
"height" : 476,
"index" : 94,
"rating" : "e",
"score" : float,
"tags" : ["ryu", "streetfighter"],
"title" : "Ryu is Hawt",
"type" : "article",
"user" : "tomfulp",
"width" : 447,
},
}),
("https://art.ngfiles.com/images/0/94_tomfulp_ryu-is-hawt.gif", {
"url": "57f182bcbbf2612690c3a54f16ffa1da5105245e",
}),
("https://www.newgrounds.com/art/view/sailoryon/yon-dream-buster", {
"url": "84eec95e663041a80630df72719f231e157e5f5d",
"count": 2,
}),
# "adult" rated (#2456)
("https://www.newgrounds.com/art/view/kekiiro/red", {
"options": (("username", None),),
"count": 1,
}),
)
def __init__(self, match):
NewgroundsExtractor.__init__(self, match)
if match.group(2):
self.user = match.group(2)
self.post_url = "https://www.newgrounds.com/art/view/{}/{}".format(
self.user, match.group(3))
else:
self.post_url = text.ensure_http_scheme(match.group(0))
def posts(self):
return (self.post_url,)
class NewgroundsMediaExtractor(NewgroundsExtractor):
"""Extractor for a media file from newgrounds.com"""
subcategory = "media"
pattern = (r"(?:https?://)?(?:www\.)?newgrounds\.com"
r"(/(?:portal/view|audio/listen)/\d+)")
test = (
("https://www.newgrounds.com/portal/view/595355", {
"pattern": r"https://uploads\.ungrounded\.net/alternate/564000"
r"/564957_alternate_31\.mp4\?1359712249",
"keyword": {
"artist" : ["kickinthehead", "danpaladin", "tomfulp"],
"comment" : "re:My fan trailer for Alien Hominid HD!",
"date" : "dt:2013-02-01 09:50:49",
"description": "Fan trailer for Alien Hominid HD!",
"favorites" : int,
"filename" : "564957_alternate_31",
"index" : 595355,
"rating" : "e",
"score" : float,
"tags" : ["alienhominid", "trailer"],
"title" : "Alien Hominid Fan Trailer",
"type" : "movie",
"user" : "kickinthehead",
},
}),
("https://www.newgrounds.com/audio/listen/609768", {
"url": "f4c5490ae559a3b05e46821bb7ee834f93a43c95",
"keyword": {
"artist" : ["zj", "tomfulp"],
"comment" : "re:RECORDED 12-09-2014\n\nFrom The ZJ \"Late ",
"date" : "dt:2015-02-23 19:31:59",
"description": "From The ZJ Report Show!",
"favorites" : int,
"index" : 609768,
"rating" : "",
"score" : float,
"tags" : ["fulp", "interview", "tom", "zj"],
"title" : "ZJ Interviews Tom Fulp!",
"type" : "music.song",
"user" : "zj",
},
}),
# flash animation (#1257)
("https://www.newgrounds.com/portal/view/161181/format/flash", {
"pattern": r"https://uploads\.ungrounded\.net/161000"
r"/161181_ddautta_mask__550x281_\.swf\?f1081628129",
"keyword": {"type": "movie"},
}),
# format selection (#1729)
("https://www.newgrounds.com/portal/view/758545", {
"options": (("format", "720p"),),
"pattern": r"https://uploads\.ungrounded\.net/alternate/1482000"
r"/1482860_alternate_102516\.720p\.mp4\?\d+",
}),
# "adult" rated (#2456)
("https://www.newgrounds.com/portal/view/717744", {
"options": (("username", None),),
"count": 1,
}),
# flash game
("https://www.newgrounds.com/portal/view/829032", {
"pattern": r"https://uploads\.ungrounded\.net/829000"
r"/829032_picovsbeardx\.swf\?f1641968445",
"range": "1",
"keyword": {
"artist" : [
"dungeonation",
"carpetbakery",
"animalspeakandrews",
"bill",
"chipollo",
"dylz49",
"gappyshamp",
"pinktophat",
"rad",
"shapeshiftingblob",
"tomfulp",
"voicesbycorey",
"psychogoldfish",
],
"comment" : "re:The children are expendable. Take out the ",
"date" : "dt:2022-01-10 23:00:57",
"description": "Bloodshed in The Big House that Blew...again!",
"favorites" : int,
"index" : 829032,
"post_url" : "https://www.newgrounds.com/portal/view/829032",
"rating" : "m",
"score" : float,
"tags" : [
"assassin",
"boyfriend",
"darnell",
"nene",
"pico",
"picos-school",
],
"title" : "PICO VS BEAR DX",
"type" : "game",
"url" : "https://uploads.ungrounded.net/829000"
"/829032_picovsbeardx.swf?f1641968445",
},
}),
)
def __init__(self, match):
NewgroundsExtractor.__init__(self, match)
self.user = ""
self.post_url = self.root + match.group(1)
def posts(self):
return (self.post_url,)
class NewgroundsArtExtractor(NewgroundsExtractor):
"""Extractor for all images of a newgrounds user"""
subcategory = _path = "art"
pattern = r"(?:https?://)?([\w-]+)\.newgrounds\.com/art/?$"
test = ("https://tomfulp.newgrounds.com/art", {
"pattern": NewgroundsImageExtractor.pattern,
"count": ">= 3",
})
class NewgroundsAudioExtractor(NewgroundsExtractor):
"""Extractor for all audio submissions of a newgrounds user"""
subcategory = _path = "audio"
pattern = r"(?:https?://)?([\w-]+)\.newgrounds\.com/audio/?$"
test = ("https://tomfulp.newgrounds.com/audio", {
"pattern": r"https://audio.ngfiles.com/\d+/\d+_.+\.mp3",
"count": ">= 4",
})
class NewgroundsMoviesExtractor(NewgroundsExtractor):
"""Extractor for all movies of a newgrounds user"""
subcategory = _path = "movies"
pattern = r"(?:https?://)?([\w-]+)\.newgrounds\.com/movies/?$"
test = ("https://tomfulp.newgrounds.com/movies", {
"pattern": r"https://uploads.ungrounded.net(/alternate)?/\d+/\d+_.+",
"range": "1-10",
"count": 10,
})
class NewgroundsGamesExtractor(NewgroundsExtractor):
"""Extractor for a newgrounds user's games"""
subcategory = _path = "games"
pattern = r"(?:https?://)?([\w-]+)\.newgrounds\.com/games/?$"
test = ("https://tomfulp.newgrounds.com/games", {
"pattern": r"https://uploads.ungrounded.net(/alternate)?/\d+/\d+_.+",
"range": "1-10",
"count": 10,
})
class NewgroundsUserExtractor(NewgroundsExtractor):
"""Extractor for a newgrounds user profile"""
subcategory = "user"
pattern = r"(?:https?://)?([\w-]+)\.newgrounds\.com/?$"
test = (
("https://tomfulp.newgrounds.com", {
"pattern": "https://tomfulp.newgrounds.com/art$",
}),
("https://tomfulp.newgrounds.com", {
"options": (("include", "all"),),
"pattern": "https://tomfulp.newgrounds.com/(art|audio|movies)$",
"count": 3,
}),
)
def items(self):
base = self.user_root + "/"
return self._dispatch_extractors((
(NewgroundsArtExtractor , base + "art"),
(NewgroundsAudioExtractor , base + "audio"),
(NewgroundsGamesExtractor , base + "games"),
(NewgroundsMoviesExtractor, base + "movies"),
), ("art",))
class NewgroundsFavoriteExtractor(NewgroundsExtractor):
"""Extractor for posts favorited by a newgrounds user"""
subcategory = "favorite"
directory_fmt = ("{category}", "{user}", "Favorites")
pattern = (r"(?:https?://)?([\w-]+)\.newgrounds\.com"
r"/favorites(?!/following)(?:/(art|audio|movies))?/?")
test = (
("https://tomfulp.newgrounds.com/favorites/art", {
"range": "1-10",
"count": ">= 10",
}),
("https://tomfulp.newgrounds.com/favorites/audio"),
("https://tomfulp.newgrounds.com/favorites/movies"),
("https://tomfulp.newgrounds.com/favorites/"),
)
def __init__(self, match):
NewgroundsExtractor.__init__(self, match)
self.kind = match.group(2)
def posts(self):
if self.kind:
return self._pagination(self.kind)
return itertools.chain.from_iterable(
self._pagination(k) for k in ("art", "audio", "movies")
)
def _pagination(self, kind):
url = "{}/favorites/{}".format(self.user_root, kind)
params = {
"page": 1,
"isAjaxRequest": "1",
}
headers = {
"Referer": url,
"X-Requested-With": "XMLHttpRequest",
}
while True:
response = self.request(url, params=params, headers=headers)
if response.history:
return
data = response.json()
favs = self._extract_favorites(data.get("component") or "")
yield from favs
if len(favs) < 24:
return
params["page"] += 1
def _extract_favorites(self, page):
return [
self.root + path
for path in text.extract_iter(
page, 'href="https://www.newgrounds.com', '"')
]
class NewgroundsFollowingExtractor(NewgroundsFavoriteExtractor):
"""Extractor for a newgrounds user's favorited users"""
subcategory = "following"
pattern = r"(?:https?://)?([\w-]+)\.newgrounds\.com/favorites/(following)"
test = ("https://tomfulp.newgrounds.com/favorites/following", {
"pattern": NewgroundsUserExtractor.pattern,
"range": "76-125",
"count": 50,
})
def items(self):
data = {"_extractor": NewgroundsUserExtractor}
for url in self._pagination(self.kind):
yield Message.Queue, url, data
@staticmethod
def _extract_favorites(page):
return [
text.ensure_http_scheme(user.rpartition('"')[2])
for user in text.extract_iter(page, 'class="item-user', '"><img')
]
class NewgroundsSearchExtractor(NewgroundsExtractor):
"""Extractor for newgrounds.com search reesults"""
subcategory = "search"
directory_fmt = ("{category}", "search", "{search_tags}")
pattern = (r"(?:https?://)?(?:www\.)?newgrounds\.com"
r"/search/conduct/([^/?#]+)/?\?([^#]+)")
test = (
("https://www.newgrounds.com/search/conduct/art?terms=tree", {
"pattern": NewgroundsImageExtractor.pattern,
"keyword": {"search_tags": "tree"},
"range": "1-10",
"count": 10,
}),
("https://www.newgrounds.com/search/conduct/movies?terms=tree", {
"pattern": r"https://uploads.ungrounded.net(/alternate)?/\d+/\d+",
"range": "1-10",
"count": 10,
}),
("https://www.newgrounds.com/search/conduct/audio?advanced=1"
"&terms=tree+green+nature&match=tdtu&genre=5&suitabilities=e%2Cm"),
)
def __init__(self, match):
NewgroundsExtractor.__init__(self, match)
self._path, query = match.groups()
self.query = text.parse_query(query)
def posts(self):
suitabilities = self.query.get("suitabilities")
if suitabilities:
data = {"view_suitability_" + s: "on"
for s in suitabilities.split(",")}
self.request(self.root + "/suitabilities",
method="POST", data=data)
return self._pagination("/search/conduct/" + self._path, self.query)
def metadata(self):
return {"search_tags": self.query.get("terms", "")}
def _pagination(self, path, params):
url = self.root + path
headers = {
"Accept": "application/json, text/javascript, */*; q=0.01",
"X-Requested-With": "XMLHttpRequest",
"Referer": self.root,
}
params["inner"] = "1"
params["page"] = 1
while True:
data = self.request(url, params=params, headers=headers).json()
post_url = None
for post_url in text.extract_iter(data["content"], 'href="', '"'):
if not post_url.startswith("/search/"):
yield post_url
if post_url is None:
return
params["page"] += 1