eunbeek/findbrokenglass

this tool looks for broken url in a input file.

findBrokenGlass

About

This repo is a open source tool to check a connection status of URLs found from the input file, using Java. It returns "[code] url status" in each line.

Features

• Looking for the URLs in the input file
• Accepting over two input files
• Returning 200 code with Good status, 400 and 404 codes with Bad status
• Colouring the output by the status : Good - Green, Bad - Red, Redirect - Blue, Fail - Red, UnKnown - Gray
• Redirecting to followed location when it is 301, 307 and 308
• Checking a version of archived URLs using the WayBackMachine
• Checking whether Urls work with https or not
• Allow to pass directory paths and recursively process all children under that directory

New Update (Nov 3, 2020)

• Returning JSON format output (Oct,6 2020)
• Exit code, 0 or the number of the broken urls (Oct 6, 2020)
• Add Ignore feature to skip list of url in the file (Oct 20, 2020)
• Add Check Telescope feature (Nov 3,2020)

Getting Started

1. Clone the repo

git clone https://github.com/eunbeek/findBrokenGlass.git

2. Run the UrlCheck.exe file in bin folder on CMD/PowerShell/Terminal

cd {cloneDirectory}/bin/[mac|window]/

Usage

Please see the appropriate guide for your CLI of choice:

CMD

This command returns a help message for the flag and the argument explanation.

UrlCheck help

You can type the input file name after tool name, then return the response code, URL and status in each line. This tool accepts multiple files and delimiters by space.

UrlCheck <fileName>

UrlCheck <fileName1> <fileName2>

You can type '--a' flag to allow checking for archived versions of URLs.

UrlCheck --a <fileName>

This '--s' flag change 'http' to 'https' in URLs and you can check whether url work with https or not.

UrlCheck --s <fileName>

This '--v' or '--version' flag return the current version.

UrlCheck --v 

This '--j' or '--json' flag return the JSON format result.

UrlCheck --j <fileName> 

This '-i' or '-ignore' flag ignores links found in the ignore file. This feature is for windows only

UrlCheck -i <fileName> <ignoreFileName>

This '-t' flag checks the latest 10 post links found in the telescope installed in local machine.

UrlCheck -t

PowerShell

This command returns a help message for the flag and the argument explanation.

./UrlCheck 

This '-t' flag checks the latest 10 post links found in the telescope installed in local machine.

./UrlCheck -t

Mac Terminal

java -jar UrlCheck.jar /m <fileName>

java -jar UrlCheck.jar /v

java -jar UrlCheck.jar /t

Library

https://github.com/java-native-access/jna

findbrokenglass's Issues

need add instruction on PowerShell in readme.md

on PowerShell, it prompts issue when typing "UrlCheck "

UrlCheck : The term 'UrlCheck' is not recognized as the name of a cmdlet, function, script file, or operable program.

add a new feature

• allow passing directory paths vs. file paths, and recursively process all children under that directory

adding Ignore URL feature

The following shall be met :
The --ignore, -i, \i flag is optional, and if present should take a filepath and use it to load and parse an ignored URLs text file. If the ignore file isn't found, give an appropriate error message. Otherwise, all URLs should be checked against this list to see if they need to be ignored.

Here are some example ignore files.

First, a file with only a comment is valid:

/1. Empty file, nothing will be ignored
Second, a file with multiple comments and a URL is valid:

/ 2. File with a comment and single URL that matches any URL
/that starts with https://www.google.com, for example:

/https://www.google.com/index.html would match
/https://www.google.com/ would match
/ https://www.google.ca would NOT match
https://www.google.com
Third, a file that has no comments and only URLs is valid:

https://www.google.com
Fourth, a file with anything other than a comment (#) or URL (http://, https://) is invalid:

/ This is invalid. It doesn't use http:// or https://
www.google.com
If the file isn't valid, give an appropriate error message and exit. Otherwise, use the file's URL patterns to test all the URLs being processed, skipping any that match.

Missing the feature

When running the tool with the v or version argument, the tool should print the name of the tool and its version.

get different result when running UrlCheck <file> or UrlCheck -s <file>

Add JSON format output feature

The URLs will return JSON format output like below.
[{"url":"http://example.com","status":200}]

Add Returning exit code feature

It will return how many bad URLs are in the file.
If all URLs are good, it will return 0.
Otherwise, the exit code is over 0.

The jar file does not run in Ubuntu linux

Hello,
I was trying to run the application in Ubuntu bash terminal. But I am getting the following error-

It is related to the library jna.