Skip to content

Sanitize names better and fix settings #87

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.

Sign up for GitHub

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

Merged
AphelionWasTaken merged 1 commit into from
Aug 23, 2026
Merged

Sanitize names better and fix settings #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,12 +176,14 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: v2.7.2
name: v2.7.2
tag_name: v2.8.0
name: v2.8.0
body: |
Fix an issue where cancelling items wouldn't clear them from the total downloads and would require a new search to redownload.
Better sanitization of game names to prevent issues with invalid characters in file paths.

Also clean up more of the codebase to make it more readable.
Allows users to change download directory and file name structure without having to search again to apply these settings.

Makes max downloads setting work as expected.
draft: false
prerelease: false
files: |
Expand Down
150 changes: 117 additions & 33 deletions PySN.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import yaml
import time
import sys
import re
import xml.etree.ElementTree as ET
from tkinter import PhotoImage
from pathlib import Path
Expand Down Expand Up @@ -101,6 +102,42 @@ def check_config():

save_dir, rpcs3_dir, folder_format, max_downloads = ConfigSettings.check_config()

class ResizableSemaphore:
def __init__(self, capacity):
self._cond = threading.Condition()
self._capacity = capacity
self._in_use = 0

def acquire(self, timeout=None):
with self._cond:
if timeout is None:
while self._in_use >= self._capacity:
self._cond.wait()
else:
if self._in_use >= self._capacity:
got = self._cond.wait_for(lambda: self._in_use < self._capacity, timeout=timeout)
if not got:
return False
self._in_use += 1
return True

def release(self):
with self._cond:
self._in_use -= 1
self._cond.notify()

def resize(self, new_capacity):
with self._cond:
self._capacity = new_capacity
self._cond.notify_all()

def __enter__(self):
self.acquire()
return self

def __exit__(self, *args):
self.release()

#Used to send messages to the queue
class ButtonAction(Enum):
STOP = 1
Expand Down Expand Up @@ -200,7 +237,7 @@ def button_save(self):
max_downloads = dl_entry

app = self.master
app.download_semaphore = threading.Semaphore(max_downloads)
app.download_semaphore.resize(max_downloads)

if self.temp_save.endswith('/'):
save_dir = self.temp_save
Expand Down Expand Up @@ -272,7 +309,7 @@ def on_mousewheel(self, event):
self._parent_canvas.yview_scroll(int(-1*(delta)), "units")

#Creates widgets within the frame, adds appropriate ones to the grid, then adds them to a list.
def add_item(self, name, title_id, ver, url, console, update_size, sha1, index, download_path, fileloc):
def add_item(self, name, title_id, ver, url, console, update_size, sha1, index, download_path, fileloc, sanitized_name):
downloadable = False
try:
#Truncates the name depending on it's length. Assigns the title id, version, and name to a label on the left side of the frame.
Expand Down Expand Up @@ -309,7 +346,7 @@ def add_item(self, name, title_id, ver, url, console, update_size, sha1, index,

#Configures the buttons to take a command with appropriate variables. Places all of the widgets on the grid.
if self.command is not None:
dlbutton.configure(command=lambda: self.command(name, title_id, url, console, update_size, sha1, index, download_path, fileloc))
dlbutton.configure(command=lambda: self.command(sanitized_name, title_id, url, console, update_size, sha1, index, download_path, fileloc))
open_button.configure(command=lambda: self.command(download_path, index, fileloc))
if not name.startswith('Invalid ID') and not name.startswith('No updates available for') and not name.startswith('PlayStation 5 title') and name != 'No updates found':
title_label.grid(row=len(self.title_label_list), column=0, pady=(0, 10), sticky='w')
Expand Down Expand Up @@ -382,7 +419,7 @@ def __init__(self):
self.after(0, lambda: self.iconphoto(True, icon))

self.hash_executor = ThreadPoolExecutor(max_workers=4)
self.download_semaphore = threading.Semaphore(max_downloads)
self.download_semaphore = ResizableSemaphore(max_downloads)
self._search_thread = None
self.session = requests.Session()
self.total_download_size = 0
Expand Down Expand Up @@ -692,7 +729,9 @@ def search(self, title_id, console, root, game_name):
update_size = int((item.get('size')))

#Assign a download path with some handling for odd characters in the game name. Add Widgets to the textbox and check if the file already exists.
name = game_name.replace(':', ' -').replace('/', ' ').replace('?', '').strip()
name = re.sub(r'[^a-zA-Z0-9_\- \u3000-\u303F\u3040-\u30FF\u4E00-\u9FFF\uFF00-\uFFEF]', '', game_name).strip()
name = re.sub(r'[\s.]+$', '', name)

if folder_format == 'id_name':
download_path = save_dir + console + '/[' + title_id + '] ' + name
else:
Expand All @@ -701,14 +740,14 @@ def search(self, title_id, console, root, game_name):
update_file = path.basename(url)
fileloc = (download_path + '/' + update_file)

self.after(0, lambda gn=name, tid=title_id, v=ver, u=url, c=console, us=update_size, s=sha1, dp=download_path, fl=fileloc:
(self.textbox.add_item(gn, tid, ' v' + v, u, c, us, s, len(self.textbox.dlbutton_list), dp, fl),
self.is_shit_there(gn, tid, dp, len(self.textbox.dlbutton_list) - 1, fl, c, s, us)))
self.after(0, lambda n=name, gn=game_name, tid=title_id, v=ver, u=url, c=console, us=update_size, s=sha1, dp=download_path, fl=fileloc:
(self.textbox.add_item(gn, tid, ' v' + v, u, c, us, s, len(self.textbox.dlbutton_list), dp, fl, n),
self.is_shit_there(n, tid, dp, len(self.textbox.dlbutton_list) - 1, fl, c, s, us)))

elif game_name == 'Invalid ID':
self.after(0, lambda: self.textbox.add_item('Invalid ID: ' + title_id, '', '', '', '', 0, '', '', '', ''))
self.after(0, lambda: self.textbox.add_item('Invalid ID: ' + title_id, '', '', '', '', 0, '', '', '', '', ''))
else:
self.after(0, lambda gn=game_name, tid=title_id: self.textbox.add_item(gn + tid, '', '', '', '', 0, '', '', '', ''))
self.after(0, lambda gn=game_name, tid=title_id: self.textbox.add_item(gn + tid, '', '', '', '', 0, '', '', '', '', ''))

#Searches specifically for PS3 DRM-free update info, and populates the widgets in the frame based on that info.
def search_no_drm(self, title_id, console, root, game_name):
Expand All @@ -729,6 +768,7 @@ def search_no_drm(self, title_id, console, root, game_name):
drmfree_list = []
sha1_list = []
update_size_list = []
game_name_list = []
name_list = []
url_list = []

Expand All @@ -741,7 +781,14 @@ def search_no_drm(self, title_id, console, root, game_name):
url_list.append(item.get('url'))
sha1_list.append(item.get('sha1sum'))
update_size_list.append(int((item.get('size'))))
name_list.append(game_name.replace(':', ' -').replace('/', ' ').replace('?', '').strip())
game_name_list.append(game_name)

name_list = game_name_list.copy()

for name in name_list:
name = re.sub(r'[^a-zA-Z0-9_\- \u3000-\u303F\u3040-\u30FF\u4E00-\u9FFF\uFF00-\uFFEF]', '', name).strip()
name = re.sub(r'[\s.]+$', '', name)

for version in package_list:
if folder_format == 'id_name':
download_path = (save_dir + console + '/[' + title_id + '] ' + name_list[i])
Expand All @@ -751,17 +798,17 @@ def search_no_drm(self, title_id, console, root, game_name):
update_file = 'DRM-Free ' + path.basename(url_list[i])
fileloc = (download_path + '/' + update_file)

self.after(0, lambda gn=name_list[i], tid=title_id, v=version, u=url_list[i], c=console, us=update_size_list[i], s=sha1_list[i], dp=download_path, fl=fileloc:
(self.textbox.add_item(gn, tid, ' v' + v + ' DRM-Free', u, c, us, s, len(self.textbox.dlbutton_list), dp, fl),
self.is_shit_there(gn, tid, dp, len(self.textbox.dlbutton_list) - 1, fl, c, s, us)))
self.after(0, lambda n=name_list[i], gn=game_name_list[i], tid=title_id, v=version, u=url_list[i], c=console, us=update_size_list[i], s=sha1_list[i], dp=download_path, fl=fileloc:
(self.textbox.add_item(gn, tid, ' v' + v + ' DRM-Free', u, c, us, s, len(self.textbox.dlbutton_list), dp, fl, n),
self.is_shit_there(n, tid, dp, len(self.textbox.dlbutton_list) - 1, fl, c, s, us)))
i = i+1
else: pass
else: pass

#Handles users searching for PS5 updates.
def search_ps5_update(self, title_id):
name = 'PlayStation 5 title updates are not supported yet.'
self.after(0, lambda: self.textbox.add_item(name, '', '', '', '', 0, '', '', '', ''))
self.after(0, lambda: self.textbox.add_item(name, '', '', '', '', 0, '', '', '', '', ''))

#Searches for PS3 firmware info, and populates the widgets in the frame based on that info.
def search_ps3_fw(self, console):
Expand Down Expand Up @@ -791,11 +838,11 @@ def search_ps3_fw(self, console):
update_file = 'v' + ver + ' ' + path.basename(url)
fileloc = (download_path + '/' + update_file)

self.after(0, lambda gn=game_name, tid=title_id, v=ver, u=url, c=console, us=update_size, s=sha1, dp=download_path, fl=fileloc:
(self.textbox.add_item(gn, tid, ' v' + v, u, c, us, s, len(self.textbox.dlbutton_list), dp, fl),
self.after(0, lambda n=game_name, gn=game_name, tid=title_id, v=ver, u=url, c=console, us=update_size, s=sha1, dp=download_path, fl=fileloc:
(self.textbox.add_item(gn, tid, ' v' + v, u, c, us, s, len(self.textbox.dlbutton_list), dp, fl, n),
self.is_shit_there(gn, tid, dp, len(self.textbox.dlbutton_list) - 1, fl, c, s, us)))

else: self.after(0, lambda: self.textbox.add_item('Error Connecting to Server', '', '', '', '', 0, '', '', '', ''))
else: self.after(0, lambda: self.textbox.add_item('Error Connecting to Server', '', '', '', '', 0, '', '', '', '', ''))

#Searches for PS4 or Vita update info and populates the widgets in the frame based on that info.
def search_ps4_ps5_vita_fw(self, console):
Expand Down Expand Up @@ -870,13 +917,13 @@ def search_ps4_ps5_vita_fw(self, console):
update_file = 'v' + ver_list[i] + ' ' + update_data_list[i] + ' ' + path.basename(url)
fileloc = (download_path + '/' + update_file)

self.after(0, lambda gn=game_name, tid=title_id, v=ver_list[i], u=url, c=console, us=update_size_list[i], s=sha1, dp=download_path, fl=fileloc:
(self.textbox.add_item(gn, tid, ' v' + v, u, c, us, s, len(self.textbox.dlbutton_list), dp, fl),
self.after(0, lambda n=game_name, gn=game_name, tid=title_id, v=ver_list[i], u=url, c=console, us=update_size_list[i], s=sha1, dp=download_path, fl=fileloc:
(self.textbox.add_item(gn, tid, ' v' + v, u, c, us, s, len(self.textbox.dlbutton_list), dp, fl, n),
self.is_shit_there(gn, tid, dp, len(self.textbox.dlbutton_list) - 1, fl, c, s, us)))

i = i+1

else: self.after(0, lambda: self.textbox.add_item('Error Connecting to Server', '', '', '', '', 0, '', '', '', ''))
else: self.after(0, lambda: self.textbox.add_item('Error Connecting to Server', '', '', '', '', 0, '', '', '', '', ''))

#Pauses and resumes download and sends pause message to the queue.
def toggle_pause(self, dl_button, q):
Expand All @@ -893,25 +940,60 @@ def cancel(self, dl_button, q):

#Creates directories, updates buttons, downloads the update file, and checks the hash.
def download_updates(self, url, download_path, size, sha1, index, title_id, name, console, fileloc, sem, prog_bar, status, dl_button, open_button, q):
if size > 0:
with sem:
def try_configure(widget, **kwargs):
try:
widget.configure(**kwargs)
except Exception:
pass
update_filename = path.basename(fileloc)

def try_set(widget, val):
if sha1 == 'N/A':
download_path = save_dir + console + '/' + console + ' Firmware' + '/' + title_id
else:
if folder_format == 'id_name':
download_path = (save_dir + console + '/[' + title_id + '] ' + name)
else:
download_path = (save_dir + console + '/' + name + ' [' + title_id + ']')

fileloc = (download_path + '/' + update_filename)

def try_configure(widget, **kwargs):
try:
widget.configure(**kwargs)
except Exception:
pass

def try_set(widget, val):
try:
widget.set(val)
except Exception:
pass

if size > 0:
try_configure(status, text_color='green', text='Queued')
try_configure(dl_button, text='Pause', command=lambda: self.toggle_pause(dl_button, q))
try_configure(open_button, text='Cancel', state = 'normal', command=lambda: self.cancel(dl_button, q))

acquired = False
while not acquired:
acquired = sem.acquire(timeout=0.25)
if not acquired:
try:
widget.set(val)
except Exception:
action = q.get_nowait()
if action == ButtonAction.PAUSE:
try_configure(status, text_color = 'yellow', text='Paused')
new_action = q.get()
if new_action == ButtonAction.STOP:
try_configure(status, text_color='red', text='Download Cancelled!')
try_configure(dl_button, command=lambda: App.frame_button_download(self, name, title_id, url, console, size, sha1, index, download_path, fileloc))
return
try_configure(status, text_color='green', text='Queued')
elif action == ButtonAction.STOP:
try_configure(status, text_color = 'red', text='Download Cancelled!')
try_configure(dl_button, command=lambda: App.frame_button_download(self, name, title_id, url, console, size, sha1, index, download_path, fileloc))
return
except queue.Empty:
pass

try:
if path.exists(download_path) == False:
create_directories(download_path)

try_configure(dl_button, text='Pause', command=lambda: self.toggle_pause(dl_button, q))
try_configure(open_button, text='Cancel', state = 'normal', command=lambda: self.cancel(dl_button, q))
try_configure(status, text_color='green', text='Downloading')

i=0
Expand Down Expand Up @@ -979,6 +1061,8 @@ def try_set(widget, val):
os.remove(fileloc)
else:
self.is_shit_there(name, title_id, download_path, index, fileloc, console, sha1, size)
finally:
sem.release()
else: pass

#Downloads all files, or only new files based on the check box in the downall window. Pretty sure it belongs in the DownloadAllWindow class.
Expand Down
Loading