Skip to content

feat: add proxy support #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 42 additions & 3 deletions tldr.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env python3
# PYTHON_ARGCOMPLETE_OK

import socket
import sys
import os
import re
Expand All @@ -10,8 +10,8 @@
from datetime import datetime
from io import BytesIO
from typing import List, Optional, Tuple, Union
from urllib.parse import quote
from urllib.request import urlopen, Request
from urllib.parse import quote, urlparse
from urllib.request import urlopen, Request, ProxyHandler, build_opener, install_opener
from urllib.error import HTTPError, URLError
from termcolor import colored
import ssl
Expand Down Expand Up @@ -564,6 +564,35 @@ def clear_cache(language: Optional[List[str]] = None) -> None:
print(f"No cache directory found for language {language}")


def check_proxy(proxy: str) -> None:
if not proxy.startswith("https://") or ":" not in proxy:
sys.exit("Error: Invalid proxy format. Expected 'https://host:port'.")

parsed = urlparse(proxy)
host = parsed.hostname
port = parsed.port

if not host or not port:
sys.exit(f"Error: Could not extract host/port from proxy URL: {proxy}")

try:
sock = socket.create_connection((host, port), timeout=10)
sock.close()
except socket.timeout:
sys.exit(f"Error: Proxy server {host}:{port} "
"connection timed out after 10 seconds.")
except socket.error as e:
sys.exit(f"Error: Could not connect to proxy server {host}:{port}. Error: {e}")


def set_proxy(proxy: str) -> None:
check_proxy(proxy)
proxyHandler = ProxyHandler({'http': f'{proxy}',
'https': f'{proxy}'})
opener = build_opener(proxyHandler)
install_opener(opener)


def create_parser() -> ArgumentParser:
parser = ArgumentParser(
prog="tldr",
Expand Down Expand Up @@ -648,6 +677,13 @@ def create_parser() -> ArgumentParser:
action="store_true",
help='Display longform options over shortform')

parser.add_argument('-x', '--proxy',
default=None,
type=str,
help='Specify a proxy server address. When a proxy is used, '
'only HTTPS connections will be routed through it. '
'Example: https://host:port.')

parser.add_argument(
'command', type=str, nargs='*', help="command to lookup", metavar='command'
).complete = {"bash": "shtab_tldr_cmd_list", "zsh": "shtab_tldr_cmd_list"}
Expand Down Expand Up @@ -689,6 +725,9 @@ def main() -> None:
if options.color is False:
os.environ["FORCE_COLOR"] = "true"

if options.proxy is not None:
set_proxy(options.proxy)

if options.update:
update_cache(language=options.language)
return
Expand Down