phub 4.7.7__tar.gz → 4.7.8__tar.gz

{phub-4.7.7 → phub-4.7.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: phub
-Version: 4.7.7
+Version: 4.7.8
 Summary: An API for Pornhub
 Author-email: Egsagon <egsagon.git@gmail.com>, EchterAlsFake <EchterAlsFake@proton.me>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -679,6 +679,7 @@ License:                     GNU GENERAL PUBLIC LICENSE
         <https://www.gnu.org/licenses/why-not-lgpl.html>.
         
 Project-URL: Documentation, https://phub.readthedocs.io
+Project-URL: Documentation_Updated, https://github.com/EchterAlsFake/API_Docs/blob/master/Porn_APIs/PHUB.md
 Project-URL: Repository, https://github.com/EchterAlsFake/PHUB
 Keywords: pornhub,phub,porn,api,web scrapper,api wrapper
 Classifier: Development Status :: 4 - Beta
@@ -688,6 +689,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx[brotli,socks]
 Requires-Dist: ffmpeg-progress-yield
+Requires-Dist: eaf_base_api
 Dynamic: license-file
 
 <p align="center">

{phub-4.7.7 → phub-4.7.8}/README.md

@@ -13,7 +13,9 @@ PHUB is an easy-to-use API wrapper for Pornhub. It can access most used or usefu
 PH features, such as video searching, account features, video downloading, and more.
 
 > [!WARNING]
-> This project is probably against Pornhub TOS. Use at your own risks.
+> This project is against PornHub's Terms of Services. Redistributing copyright protected content is a crime under DMCA. 
+> Usage of this API is intended for **PRIVATE** non-commercial purposes only. We are not responsible for damages caused by
+> this project. Please use it responsibly to ensure the continued development for everyone!
 
 # Installation
 
@@ -30,26 +32,26 @@ pip install --upgrade git+https://github.com/EchterAlsFake/PHUB.git
 # Usage from command line
 ```shell
 # Download a single video
-py -m phub https://www.pornhub.com/view_video.php?viewkey=abcdef
+phub -url https://www.pornhub.com/view_video.php?viewkey=abcdef
 # Download multiple videos from a text file
-py -m phub path/to/file.txt --quality best --downloader threaded --output video.mp4
+phub -file path/to/file.txt --quality best --downloader threaded --output video.mp4
 ```
 
 # Quickstart
 
 > [!NOTE]
-> You can find the docs on this project [here](https://phub.readthedocs.io).
+> You can find the beautiful outdated docs on this project [here](https://phub.readthedocs.io).
+> <br>Or use the ugly but **UPDATED** docs (xD) [here](https://github.com/EchterAlsFake/API_Docs/blob/master/Porn_APIs/PHUB.md)
 
 ```python
 import phub
-from phub.locals import *
 
 # Initialise a client
 client = phub.Client()
 
 # Fetch and download a video
 video = client.get('https://...')
-video.download('my-video.mp4', Quality.BEST)
+video.download('my-video.mp4', quality="best") # See docs for more options
 
 # Fetch user videos
 user = client.get_user('this-user')
@@ -61,7 +63,7 @@ for video in client.search('my-query'):
     print(video.title)
 
 # Connect to an account
-client = phub.Client('my-username', 'my-password')
+client = phub.Client('my-email', 'my-password')
 
 # Access account history, liked and recommended stuff
 client.account.watched
@@ -76,6 +78,12 @@ This repository was initiated and maintained by [Egsagon](https://github.com/Egs
 He doesn't have any time to maintain this and transferred me the ownership.
 I'll do my best to maintain this repository functional.
 
+# Donations
+If you want to donate, I and Egsagon will gladly appreciate it. Donations will be split 50/50 between us. 
+Please use PayPal for donating, as it makes it easier. Thanks a lot! 
+
+- https://paypal.me/EchterAlsFake
+
 # Contributing
 Feel free to contribute to this project by submitting
 feature requests, issues, bugs, or whatever.

{phub-4.7.7 → phub-4.7.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "phub"
-version = "4.7.7"
+version = "4.7.8"
 description = "An API for Pornhub"
 authors = [
   {name = 'Egsagon', email = "egsagon.git@gmail.com"},
@@ -13,7 +13,7 @@ classifiers = [
   "Development Status :: 4 - Beta",
   "Programming Language :: Python"
 ]
-dependencies = ["httpx[brotli,socks]", "ffmpeg-progress-yield"]
+dependencies = ["httpx[brotli,socks]", "ffmpeg-progress-yield", "eaf_base_api"]
 requires-python = ">=3.9"
 
 
@@ -22,6 +22,7 @@ phub = "phub.__main__:main"
 
 [project.urls]
 Documentation = "https://phub.readthedocs.io"
+Documentation_Updated = "https://github.com/EchterAlsFake/API_Docs/blob/master/Porn_APIs/PHUB.md"
 Repository = "https://github.com/EchterAlsFake/PHUB"
 
 [build-system]

{phub-4.7.7 → phub-4.7.8}/src/phub/__init__.py

@@ -11,12 +11,11 @@ __copyright__ = 'Copyright 2024, PHUB'
 __license__ = 'GPLv3'
 __version__  = '4.7.2'
 
-__all__ = ['Client', 'Quality', 'core', 'utils',
+__all__ = ['Client', 'core', 'utils',
            'consts', 'errors', 'objects', 'modules']
 
 # Shortcuts
 from .core import Client
-from .utils import Quality
 
 # Sub modules
 from . import core

{phub-4.7.7 → phub-4.7.8}/src/phub/__main__.py

@@ -4,9 +4,9 @@ PHUB built-in CLI.
 
 import os
 import argparse
+import re
 
 from phub import Client, Video
-from phub.modules.download import threaded, FFMPEG, default
 
 
 def text_progress_bar(downloaded, total, title=False):
@@ -33,21 +33,13 @@ def download_video(client: Client, url: [str, Video], output: str, quality: str,
     else:
         raise "Some error happened here, please report on GitHub, thank you :) "
 
-    title = video.title
+    title =  re.sub(r'[<>:"/\\|?*]', '', video.title)
     final_output_path = os.path.join(output, title + ".mp4")
 
     print(f"Downloading: {title} to: {final_output_path}")
     video.download(path=final_output_path, quality=quality, downloader=downloader, display=text_progress_bar)
     print(f"Successfully downloaded: {title}")
 
-def resolve_threading_mode(mode, workers=10, timeout=10):
-    """Resolve the appropriate threading mode based on input."""
-    return {
-        "threaded": threaded(max_workers=workers, timeout=timeout),
-        "ffmpeg": FFMPEG,
-        "default": default
-    }.get(mode, default)
-
 
 def main():
     parser = argparse.ArgumentParser(description="PHUB built-in CLI")
@@ -67,7 +59,7 @@ def main():
     args = parser.parse_args()
     quality = args.quality
     output = args.output
-    downloader = resolve_threading_mode(mode=args.downloader)
+    downloader = args.downloader
     url = args.url
     model = args.model
     video_limit = args.video_limit
@@ -109,4 +101,4 @@ def main():
 if __name__ == '__main__':
     main()
 
-# EOF
+# EOF

{phub-4.7.7 → phub-4.7.8}/src/phub/consts.py

@@ -36,22 +36,6 @@ LOGIN_PAYLOAD = {
 }
 
 RSS = 'https://www.pornhub.com/video/webmasterss'
-
-PROXY = None
-# Can be any http or socks proxy
-
-
-MAX_CALL_RETRIES = 4 # Maximum times a HTTPError can be reproduced
-MAX_CALL_TIMEOUT = .4 # Time to wait before retrying basic calls
-CALL_TIMEOUT = 30 # Time to wait before retrying calls (in case no error happens)
-CHALLENGE_TIMEOUT = 2 # Time to wait before injecting the new cookie for resolving the challenge (needs to be at least 1)
-DELAY = 0 # Minimum time between requests
-
-DOWNLOAD_SEGMENT_MAX_ATTEMPS = 5
-DOWNLOAD_SEGMENT_ERROR_DELAY = .5
-
-FFMPEG_EXECUTABLE = 'ffmpeg' # Use from PATH by default
-
 IFRAME = '<iframe src="https://www.pornhub.com/embed/{key}" frameborder="0" width="{width}" height="{height}" scrolling="no" allowfullscreen></iframe>'
 
 # Supported languages

{phub-4.7.7 → phub-4.7.8}/src/phub/core.py

@@ -5,23 +5,23 @@ PHUB core module.
 import time
 import logging
 import random
-
 import httpx
+
 from typing import Iterable, Union
 from functools import cached_property
+from base_api.base import BaseCore, setup_logger
 
 from . import utils
 from . import consts
 from . import errors
 from . import literals
+from .errors import LoginFailed
 
 from .modules import parser
 
 from .objects import (Video, User,
                       Account, Query, queries, Playlist)
 
-logger = logging.getLogger(__name__)
-
 
 class Client:
     '''
@@ -38,7 +38,8 @@ class Client:
                  login: bool = True,
                  bypass_geo_blocking: bool = False,
                  change_title_language: bool = True,
-                 use_webmaster_api: bool = True) -> None:
+                 use_webmaster_api: bool = True,
+                 core=None) -> None:
         '''
         Initialises a new client.
         
@@ -54,8 +55,13 @@ class Client:
             LoginFailed: If Pornhub refuses the authentication.
                 The reason will be passed as the error body.
         '''
-        
-        logger.debug('Initialised new Client %s', self)
+
+        self.logger = setup_logger(name="PHUB API - [Client]", log_file=None, level=logging.ERROR)
+        self.core = core or BaseCore()
+        self.core.config.cookies = consts.COOKIES
+        self.core.config.headers = consts.HEADERS
+        # Applying PornHub specific cookies and headers to base API
+        self.logger.debug('Initialised new Client %s', self)
 
         # Initialise session
         Client.use_webmaster_api = use_webmaster_api
@@ -65,41 +71,30 @@ class Client:
 
         self.reset()
 
-        self.session.headers.update({"Accept-Language": language})
+        self.core.config.headers.update({"Accept-Language": language})
+        self.core.update_headers({"Accept-Language": language})
         self.credentials = {'email': email,
                             'password': password}
-        
-        self.delay = consts.DELAY
-        self.start_delay = False
-        self.last_request_time = None
-        
+
+
         # Connect account
         self.logged = False
         self.account = Account(self)
-        logger.debug('Connected account to client %s', self.account)
+        self.logger.debug('Connected account to client %s', self.account)
         
         # Automatic login
         if login and self.account:
             self.login()
-    
+
+    def enable_logging(self, log_file: str = None, level = None, log_ip=None, log_port=None):
+        self.logger = setup_logger(name="PHUB API - [Client]", log_file=log_file, level=level, http_ip=log_ip, http_port=log_port)
+
     def reset(self) -> None:
         '''
         Reset the client requests session.
         This is useful if you are keeping the client running
         for a long time and can help with Pornhub rate limit.
         '''
-        verify = True
-        if consts.PROXY is not None:
-            verify = False
-
-        # Initialise session
-        self.session = httpx.Client(
-            headers = consts.HEADERS,
-            cookies = consts.COOKIES,
-            follow_redirects = True,
-            proxy = consts.PROXY,
-            verify = verify)
-
         self._clear_granted_token()
 
         if self.bypass_geo_blocking:
@@ -107,21 +102,21 @@ class Client:
             language_code = "fr"
 
             # Faking the X-Forwarded-For header (Fake IP source)
-            self.session.headers.update({"X-Forwarded-For": f"{ip}"})
+            self.core.config.headers.update({"X-Forwarded-For": f"{ip}"})
             # Setting the Accept-Language tag to French, because the faked IP comes from france
-            self.session.headers.update({"Accept-Language": f"{language_code}"})
+            self.core.config.headers.update({"Accept-Language": f"{language_code}"})
             # Setting the country code also to french
-            self.session.headers.update({"CF-IPCountry": f"{language_code}"})
-            logging.debug(f"Using faked headers for geo-bypass: {self.session.headers}")
+            self.core.config.headers.update({"CF-IPCountry": f"{language_code}"})
+            logging.debug(f"Using faked headers for geo-bypass: {self.core.config.session.headers}")
 
     def call(self,
              func: str,
              method: str = 'GET',
              data: dict = None,
              headers: dict = None,
-             timeout: float = consts.CALL_TIMEOUT,
              throw: bool = True,
-             silent: bool = False) -> httpx.Response:
+             silent: bool = False,
+             get_response = True) -> httpx.Response:
         '''
         Used internally to send a request or an API call.
 
@@ -130,7 +125,6 @@ class Client:
             method (str): Request method (GET, POST, PUT, ...).
             data (dict): Optional data to send to the server.
             headers (dict): Additional request headers.
-            timeout (float): Request maximum response time.
             throw (bool): Whether to raise an error when a request explicitly fails.
             silent (bool): Whether to supress this call from logs.
 
@@ -142,15 +136,10 @@ class Client:
             HTTPError: If the request failed, for any reason.
         '''
         func = utils.fix_url(func)
-        logger.log(logging.DEBUG if silent else logging.INFO, 'Fetching %s', func or '/')
+        self.logger.log(logging.DEBUG if silent else logging.INFO, 'Fetching %s', func or '/')
 
-        # Delay mechanism
-        if self.last_request_time:
-            elapsed_time = time.time() - self.last_request_time
-            if elapsed_time < self.delay:
-                time.sleep(self.delay - elapsed_time)
-
-        self.last_request_time = time.time()  # Update the time of the last request
+        if headers:
+            self.core.config.headers = headers
 
         if not self.language == "en":
             host = consts.LANGUAGE_MAPPING.get(self.language)
@@ -160,15 +149,13 @@ class Client:
             host = consts.HOST
 
         url = func if 'http' in func else utils.concat(host, func)
-        for i in range(consts.MAX_CALL_RETRIES):
+        for i in range(self.core.config.max_retries):
             try:
-                response = self.session.request(
+                response = self.core.fetch(
                     method = method,
                     url = url,
-                    headers = headers,
                     data = data,
-                    timeout = timeout
-                )
+                    get_response=get_response)
 
                 # Silent 429 errors
                 if b'429</title>' in response.content:
@@ -177,19 +164,18 @@ class Client:
                 # Attempt to resolve the challenge if needed
                 challenge = consts.re.get_challenge(response.text, False)
                 if challenge:
-                    logger.info('Challenge found, attempting to resolve')
+                    self.logger.info('Challenge found, attempting to resolve')
                     parser.challenge(self, *challenge)
                     
-                    logger.info(f"Sleeping for {consts.CHALLENGE_TIMEOUT} seconds")
-                    time.sleep(consts.CHALLENGE_TIMEOUT)
+                    self.logger.info(f"Sleeping for 1.5 seconds")
+                    time.sleep(1.5) # Yes, we need to sleep that amount, otherwise PornHub refuses the challenge.
                     continue  # Reload page
 
                 break
 
             except Exception as err:
-                logger.log(logging.DEBUG if silent else logging.WARNING,
-                           f'Call failed: {repr(err)}. Retrying (attempt {i + 1}/{consts.MAX_CALL_RETRIES})')
-                time.sleep(consts.MAX_CALL_TIMEOUT)
+                self.logger.log(logging.DEBUG if silent else logging.WARNING,
+                           f'Call failed: {repr(err)}. Retrying (attempt {i + 1}/{self.core.config.max_retries})')
                 continue
 
         else:
@@ -216,16 +202,20 @@ class Client:
             LoginFailed: If the login failed, for a reason passed in the error body.
         '''
         
-        logger.debug('Attempting login')
+        self.logger.debug('Attempting login')
         
         if not force and self.logged:
-            logger.error('Client is already logged in')
+            self.logger.error('Client is already logged in')
             raise errors.ClientAlreadyLogged()
     
         # Get token
         page = self.call('').text
-        base_token = consts.re.get_token(page)
-        
+        try:
+            base_token = consts.re.get_token(page)
+
+        except errors.RegexError:
+            raise LoginFailed("(Probably) invalid credentials. If you are sure they are correct, please report this issue.")
+
         # Send credentials
         payload = consts.LOGIN_PAYLOAD | self.credentials | {'token': base_token}
         response = self.call('front/authenticate', method = 'POST', data = payload)
@@ -236,7 +226,7 @@ class Client:
         message = data.get('message')
         
         if throw and not success:
-            logger.error('Login failed: Received error: %s', message)
+            self.logger.error('Login failed: Received error: %s', message)
             raise errors.LoginFailed(message)
         
         # Reset token
@@ -258,7 +248,7 @@ class Client:
             Video: The corresponding video object.
         '''
         
-        logger.debug(f'Fetching video at {video}')
+        self.logger.debug(f'Fetching video at {video}')
 
         if isinstance(video, Video):
             # User might want to re-init a video,
@@ -296,7 +286,7 @@ class Client:
         if isinstance(user, User):
             user = user.url
         
-        logger.debug('Fetching user %s', user)
+        self.logger.debug('Fetching user %s', user)
         return User.get(self, user)
 
     def search_hubtraffic(self,
@@ -308,7 +298,7 @@ class Client:
                period: literals.ht_period = None) -> Query:
         '''
         Perform searching on Pornhub using the HubTraffic API.
-        It is condidered to be much faster but has less filters.
+        It is considered to be much faster but has less filters.
         
         Args:
             query (str): The query to search.

{phub-4.7.7 → phub-4.7.8}/src/phub/modules/__init__.py

@@ -2,11 +2,10 @@
 PHUB submodules.
 '''
 
-__all__ = ['parser', 'display', 'download', 'rss']
+__all__ = ['parser', 'display', 'rss']
 
 from . import rss
 from . import parser
 from . import display
-from . import download
 
 # EOF

{phub-4.7.7 → phub-4.7.8}/src/phub/modules/parser.py

@@ -79,7 +79,8 @@ def challenge(client: Client, challenge: str, token: str) -> None:
     
     # Build and inject cookie
     cookie = f'{n}*{p // n}:{s}:{token}:1'
-    client.session.cookies.set('KEY', cookie)
+    client.core.config.cookies = {'KEY', cookie}
+    client.core.update_cookies()
     logger.info('Injected cookie %s', cookie)
-
+    print("Injected cookie for authentication")
 # EOF

{phub-4.7.7 → phub-4.7.8}/src/phub/objects/account.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import logging
 from functools import cached_property
+from base_api.base import setup_logger
 from typing import TYPE_CHECKING, Literal, Iterator, Union
 
 from .. import utils
@@ -12,8 +13,6 @@ if TYPE_CHECKING:
     from ..core import Client
     from . import Feed, queries, User
 
-logger = logging.getLogger(__name__)
-
 
 class Account:
     '''
@@ -45,6 +44,7 @@ class Account:
         '''
         
         self.client = client
+        self.logger = setup_logger(name="PHUB API - [Account]", log_file=None, level=logging.ERROR)
         
         self.name: str = None
         self.avatar: Image = None
@@ -54,9 +54,12 @@ class Account:
         # Save data keys so far, so we can make a difference with the
         # cached property ones.
         self.loaded_keys = list(self.__dict__.keys()) + ['loaded_keys']
-            
+
+    def enable_logging(self, log_file: str = None, level=None, log_ip=None, log_port=None):
+        self.logger = setup_logger(name="PHUB API - [Account]", log_file=log_file, level=level, http_ip=log_ip,
+                                   http_port=log_port)
+
     def __repr__(self) -> str:
-        
         status = 'logged-out' if self.name is None else f'name={self.name}' 
         return f'phub.Account({status})'
 
@@ -77,7 +80,7 @@ class Account:
         
         # We assert that the account is from a normal user (not model, etc.)
         if not 'users/' in self.user.url:
-            logger.error('Invalid user type: %s', url)
+            self.logger.error('Invalid user type: %s', url)
             raise NotImplementedError('Non-user account are not supported.')
     
     def refresh(self, refresh_login: bool = False) -> None:
@@ -88,25 +91,25 @@ class Account:
             refresh_login (bool): Whether to also attempt to re-log in.
         '''
         
-        logger.info('Refreshing account %s', self)
+        self.logger.info('Refreshing account %s', self)
         
         if refresh_login:
-            logger.info('Forcing login refresh')
+            self.logger.info('Forcing login refresh')
             self.client.login(force = True)
         
         # Clear properties cache
         for key in list(self.__dict__.keys()):
             if not key in self.loaded_keys:
                 
-                logger.debug('Deleting key %s', key)
+                self.logger.debug('Deleting key %s', key)
                 delattr(self, key)
     
     def fix_recommendations(self) -> None:
         '''
-        Allow recommandations cookies.
+        Allow recommendations cookies.
         '''
         
-        logger.info('Fixing account recommendations')
+        self.logger.info('Fixing account recommendations')
         
         payload = utils.urlify({
             'token': self.client._granted_token,

{phub-4.7.7 → phub-4.7.8}/src/phub/objects/feed.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import logging
 from functools import cached_property
+from base_api.base import setup_logger
 from typing import TYPE_CHECKING, Callable, Iterator, Union
 
 from .. import literals
@@ -11,8 +12,6 @@ if TYPE_CHECKING:
     from . import queries
     from ..core import Client
 
-logger = logging.getLogger(__name__)
-
 
 class Feed:
     '''
@@ -28,9 +27,13 @@ class Feed:
         '''
         
         self.client = client
-        
-        logger.debug('Initialised account feed: %s', self)
-    
+        self.logger = setup_logger(name="PHUB API - [Feed]", log_file=None, level=logging.ERROR)
+        self.logger.debug('Initialised account feed: %s', self)
+
+    def enable_logging(self, log_file: str = None, level=None, log_ip=None, log_port=None):
+        self.logger = setup_logger(name="PHUB API - [Feed]", log_file=log_file, level=level, http_ip=log_ip,
+                                   http_port=log_port)
+
     def __repr__(self) -> str:
         
         return f'phub.FeedCreator(for={self.client.account.name})'
@@ -51,7 +54,7 @@ class Feed:
         # Generate args
         username = user.name if isinstance(user, User) else user
         
-        logger.info('Generating new filter feed using args', )
+        self.logger.info('Generating new filter feed using args', )
         
         return queries.FeedQuery(
             client = self.client,

{phub-4.7.7 → phub-4.7.8}/src/phub/objects/image.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import os
 import logging
+from base_api.base import setup_logger
 from typing import TYPE_CHECKING, Literal, Union
 
 from .. import utils
@@ -10,9 +11,6 @@ if TYPE_CHECKING:
     from ..core import Client
 
 
-logger = logging.getLogger(__name__)
-
-
 class Image:
     '''
     Represents an image hosted on Pornhub.
@@ -34,19 +32,24 @@ class Image:
             name (str): Image name.
         '''
 
+        self.logger = setup_logger(name="PHUB API - [Image]", log_file=None, level=logging.ERROR)
         self.url = url
         self.name = name
         self.client = client
         self._servers = servers or []
         
-        logger.debug('Generated new image object: %s', self)
+        self.logger.debug('Generated new image object: %s', self)
         
         # Check server image sizes
         sizes = [s.get('size') for s in self._servers]
         
         if len(set(sizes)) > 1:
-            logger.warning('Detected different image sizes on alt servers: %s', sizes)
-    
+            self.logger.warning('Detected different image sizes on alt servers: %s', sizes)
+
+    def enable_logging(self, log_file: str = None, level=None, log_ip=None, log_port=None):
+        self.logger = setup_logger(name="PHUB API - [Image]", log_file=log_file, level=level, http_ip=log_ip,
+                                   http_port=log_port)
+
     def __repr__(self) -> str:
         
         return f'phub.Image(name={self.name})'
@@ -70,7 +73,7 @@ class Image:
         if os.path.isdir(path):
             path = utils.concat(path, self.name + ext)
         
-        logger.info('Saving %s at %s', self, path)
+        self.logger.info('Saving %s at %s', self, path)
         
         with open(path, 'wb') as file:
             
@@ -81,12 +84,12 @@ class Image:
                 
             except Exception as err:
                 
-                logger.warning('Failed to get image `%s`', url)
+                self.logger.warning('Failed to get image `%s`', url)
                 if not self._servers: raise err
                 
                 # Pop server and retry
                 server = self._servers.pop(0)
-                logger.info('Retrying download with server %s', server)
+                self.logger.info('Retrying download with server %s', server)
                 self.url = server['src']
                 self.download(path)