1
0
mirror of https://github.com/mikf/gallery-dl.git synced 2024-11-23 03:02:50 +01:00
gallery-dl/gallery_dl/extractor/newgrounds.py
Mike Fährmann b1f0609de5
[newgrounds] rewrite (#394)
- restructure extractor hierarchy
- extract more metadata
- extract videos without youtube-dl
- be more resilient to errors

TODO:
- favorites
- games, but that might be near impossible for non-flash titles
2019-11-18 21:13:33 +01:00

351 lines
13 KiB
Python

# -*- coding: utf-8 -*-
# Copyright 2018-2019 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, exception
from ..cache import cache
import json
class NewgroundsExtractor(Extractor):
"""Base class for newgrounds extractors"""
category = "newgrounds"
directory_fmt = ("{category}", "{artist[:10]:J, }")
filename_fmt = "{category}_{index}_{title}.{extension}"
archive_fmt = "{index}"
root = "https://www.newgrounds.com"
cookiedomain = ".newgrounds.com"
cookienames = ("NG_GG_username", "vmk1du5I8m")
def __init__(self, match):
Extractor.__init__(self, match)
self.user = match.group(1)
self.user_root = "https://{}.newgrounds.com".format(self.user)
def items(self):
self.login()
yield Message.Version, 1
for post_url in self.posts():
try:
file = self.extract_post(post_url)
url = file["url"]
# except Exception:
except OSError:
url = None
if not url:
self.log.warning("Unable to get download URL for %s", post_url)
continue
yield Message.Directory, file
yield Message.Url, url, text.nameext_from_url(url, file)
def posts(self):
"""Return urls of all relevant image pages"""
return self._pagination(self.subcategory)
def login(self):
username, password = self._get_auth_info()
if username:
self._update_cookies(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/"
page = self.request(url).text
headers = {"Origin": self.root, "Referer": url}
url = text.urljoin(self.root, text.extract(page, 'action="', '"')[0])
data = {
"username": username,
"password": password,
"remember": "1",
"login" : "1",
}
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.cookiedomain
}
def extract_post(self, post_url):
page = self.request(post_url).text
extr = text.extract_from(page)
if "/art/view/" in post_url:
data = self._extract_image_data(extr, post_url)
elif "/audio/listen/" in post_url:
data = self._extract_audio_data(extr, post_url)
else:
data = self._extract_media_data(extr, post_url)
data["comment"] = text.unescape(text.remove_html(extr(
'id="author_comments">', '</div>'), "", ""))
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 momag">', '</dd>'))
data["artist"] = [
text.extract(user, '//', '.')[0]
for user in text.extract_iter(page, '<div class="item-user">', '>')
]
data["tags"].sort()
data["user"] = self.user or data["artist"][0]
return data
@staticmethod
def _extract_image_data(extr, url):
full = text.extract_from(json.loads(extr('"full_image_text":', '});')))
data = {
"title" : text.unescape(extr('"og:title" content="', '"')),
"description": text.unescape(extr(':description" content="', '"')),
"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="', '"')),
}
data["index"] = text.parse_int(
data["url"].rpartition("/")[2].partition("_")[0])
return data
@staticmethod
def _extract_audio_data(extr, url):
return {
"title" : text.unescape(extr('"og:title" content="', '"')),
"description": text.unescape(extr(':description" content="', '"')),
"date" : text.parse_datetime(extr(
'itemprop="datePublished" content="', '"')),
"url" : extr('{"url":"', '"').replace("\\/", "/"),
"index" : text.parse_int(url.split("/")[5]),
"rating" : "",
}
@staticmethod
def _extract_media_data(extr, url):
return {
"title" : text.unescape(extr('"og:title" content="', '"')),
"url" : extr('{"url":"', '"').replace("\\/", "/"),
"date" : text.parse_datetime(extr(
'itemprop="datePublished" content="', '"')),
"description": text.unescape(extr(
'itemprop="description" content="', '"')),
"rating" : extr('class="rated-', '"'),
"index" : text.parse_int(url.split("/")[5]),
}
def _pagination(self, kind):
root = self.user_root
headers = {
"Accept": "application/json, text/javascript, */*; q=0.01",
"X-Requested-With": "XMLHttpRequest",
"Referer": root,
}
url = "{}/{}/page/1".format(root, kind)
while True:
with self.request(url, 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)
for year in data["sequence"]:
for item in data["years"][str(year)]["items"]:
page_url = text.extract(item, 'href="', '"')[0]
yield text.urljoin(root, page_url)
if not data["more"]:
return
url = text.urljoin(root, data["more"])
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" : "type:datetime",
"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",
"user" : "tomfulp",
"width" : 447,
},
}),
("https://art.ngfiles.com/images/0/94_tomfulp_ryu-is-hawt.gif", {
"url": "57f182bcbbf2612690c3a54f16ffa1da5105245e",
}),
)
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:
url = match.group(0)
if not url.startswith("http"):
url = "https://" + url
self.post_url = url
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/589549", {
"url": "48d916d819c99139e6a3acbbf659a78a867d363e",
"content": "ceb865426727ec887177d99e0d20bb021e8606ae",
"keyword": {
"artist" : ["psychogoldfish", "tomfulp"],
"comment" : "re:People have been asking me how I like the ",
"date" : "type:datetime",
"description": "re:People have been asking how I like the ",
"favorites" : int,
"filename" : "527818_alternate_1896",
"index" : 589549,
"rating" : "t",
"score" : float,
"tags" : ["newgrounds", "psychogoldfish",
"rage", "redesign-2012"],
"title" : "Redesign Rage",
"user" : "psychogoldfish",
},
}),
("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" : "type:datetime",
"description": "From The ZJ Report Show!",
"favorites" : 18,
"index" : 609768,
"rating" : "",
"score" : float,
"tags" : ["fulp", "interview", "tom", "zj"],
"title" : "ZJ Interviews Tom Fulp!",
"user" : "zj",
},
}),
)
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 = "art"
pattern = r"(?:https?://)?([^.]+)\.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 = "audio"
pattern = r"(?:https?://)?([^.]+)\.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 = "movies"
pattern = r"(?:https?://)?([^.]+)\.newgrounds\.com/movies/?$"
test = ("https://tomfulp.newgrounds.com/movies", {
"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?://)?([^.]+)\.newgrounds\.com/?$"
test = (
("https://tomfulp.newgrounds.com", {
"pattern": "https://tomfulp.newgrounds.com/art$",
"count": 1,
}),
("https://tomfulp.newgrounds.com", {
"options": (("include", "all"),),
"pattern": "https://tomfulp.newgrounds.com/(art|audio|movies)$",
"count": 3,
}),
)
def items(self):
data = {}
extr_map = {
"art": NewgroundsArtExtractor,
"audio": NewgroundsAudioExtractor,
"movies": NewgroundsMoviesExtractor,
}
include = self.config("include", ("art",)) or ()
if include == "all":
include = extr_map.keys()
elif isinstance(include, str):
include = include.split(",")
yield Message.Version, 1
for category in include:
if category in extr_map:
url = self.user_root + "/" + category
data["_extractor"] = extr_map[category]
yield Message.Queue, url, data