RipMeApp/ripme

Implement subdirectory sanitisation

Open

#16 opened on Jul 9, 2017

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Java (3,524 stars) (640 forks)batch import
enhancementhelp wanted

Description

The addURLToDownload method in AbstractRipper should have sanitisation implemented for sub directories. It's currently possible to pass invalid characters and have the directory creation fail. This is particularly an issue on Windows platforms.

Another side effect of no sanitisation is that slashes in the directory name create further subdirectories.

Contributor guide

Tech stack
java
Domain
clidesktop
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Javafile I/Oregular expressions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the addURLToDownload method in AbstractRipper.java. Implement a sanitization function that removes or replaces invalid filesystem characters (e.g., <, >, :, ", /, \, |, ?, *) from subdirectory names. Consider using platform specific filename checks like File.separatorChar or a regex pattern. Look at any existing test files for ripper methods and consider adding a unit test for the sanitization logic. Check the issue comments for any proposed solutions or discussions.