Update script.py

Added Verbose mode

.gitignore

@@ -1,4 +1,5 @@
+build/
+dist/
+MANIFEST
 __pycache__/
-src/__pycache__/
-logs/
-*.json
+src/__pycache__/

README.md

@@ -1,41 +1,29 @@
 # Bulk Downloader for Reddit
 This program downloads imgur, gfycat and direct image and video links of saved posts from a reddit account. It is written in Python 3.
   
-**PLEASE** post any issue you had with the script to [Issues](https://github.com/aliparlakci/bulk-downloader-for-reddit/issues) tab. Since I don't have any testers or contributers I need your feedback.
+**PLEASE** post any issue you have with the script to [Issues](https://github.com/aliparlakci/bulk-downloader-for-reddit/issues) tab. Since I don't have any testers or contributers I need your feedback.
 
-## Table of Contents
+## What it can do
+- Can get posts from: frontpage, subreddits, multireddits, redditor's submissions, upvoted and saved posts; search results or just plain reddit links
+- Sorts posts by hot, top, new and so on
+- Downloads **REDDIT** images and videos, **IMGUR** images and albums, **GFYCAT** links, **EROME** images and albums, **SELF POSTS** and any link to a **DIRECT IMAGE**
+- Skips the existing ones
+- Puts post title and OP's name in file's name
+- Puts every post to its subreddit's folder
+- Saves a reusable copy of posts' details that are found so that they can be re-downloaded again
+- Logs failed ones in a file to so that you can try to download them later
 
-- [What it can do?](#what-it-can-do)
-- [Requirements](#requirements)
-- [Setting up the script](#setting-up-the-script)
-  - [Creating an imgur app](#creating-an-imgur-app)
-- [Program Modes](#program-modes)
-- [Running the script](#running-the-script)
-  - [Using the command line arguments](#using-the-command-line-arguments)
-  - [Examples](#examples)
-- [FAQ](#faq)
-- [Changelog](#changelog)
+## [Download the latest release](https://github.com/aliparlakci/bulk-downloader-for-reddit/releases/latest)
 
-## What it can do?
-### It...
-- can get posts from: frontpage, subreddits, multireddits, redditor's submissions, upvoted and saved posts; search results or just plain reddit links
-- sorts post by hot, top, new and so on
-- downloads imgur albums, gfycat links, [self posts](#i-can-t-open-the-self-posts-) and any link to a direct image
-- skips the existing ones
-- puts post titles to file's name
-- puts every post to its subreddit's folder
-- saves reusable a copy of posts' details that are found so that they can be re-downloaded again
-- logs failed ones in a file to so that you can try to download them later
-- can be run with double-clicking on Windows (but I don't recommend it)
-
-## Requirements
-- Python 3.x*
-
-You can install Python 3 here: [https://www.python.org/downloads/](https://www.python.org/downloads/)  
+## How it works
   
-You have to check "**Add Python 3 to PATH**" option when installing in order it to run correctly.
+- For **Windows** and **Linux** users, there are executable files to run easily without installing a third party program. But if you are a paranoid like me, you can **[compile it from source code](docs/COMPILE_FROM_SOURCE.md)**.
+  - In Windows, double click on bulk-downloader-for-reddit file
+  - In Linux, extract files to a folder and open terminal inside it. Type **`./bulk-downloader-for-reddit`**
+  
+- **MacOS** users have to **[compile it from source code](docs/COMPILE_FROM_SOURCE.md)**.
 
-*\*Although the latest version of python is suggested, you can use 3.6.5 since it runs perfectly on that version*
+Script also accepts **command-line arguments**, get further information from **[`--help`](docs/COMMAND_LINE_ARGUMENTS.md)**
 
 ## Setting up the script
 Because this is not a commercial app, you need to create an imgur developer app in order API to work.
@@ -50,120 +38,78 @@ Because this is not a commercial app, you need to create an imgur developer app
   
 It should redirect to a page which shows your **imgur_client_id** and **imgur_client_secret**
   
-\*Select **OAuth 2 authorization without a callback URL** first then select **Anonymous usage without user authorization** if it says *Authorization callback URL: required*
-
-## Program Modes
-All the program modes are activated with command-line arguments as shown [here](#using-the-command-line-arguments)  
-- **saved mode**
-  - Gets posts from given user's saved posts.
-- **submitted mode**
-  - Gets posts from given user's submitted posts.
-- **upvoted mode**
-  - Gets posts from given user's upvoted posts.
-- **subreddit mode**
-  - Gets posts from given subreddit or subreddits that is sorted by given type and limited by given number.
-  - You may also use search in this mode. See [`py -3 script.py --help`](#using-the-command-line-arguments).
-- **multireddit mode**
-  - Gets posts from given user's given multireddit that is sorted by given type and limited by given number.  
-- **link mode**
-  - Gets posts from given reddit link.  
-  - You may customize the behaviour with `--sort`, `--time`, `--limit`.
-  - You may also use search in this mode. See [`py -3 script.py --help`](#using-the-command-line-arguments).
-- **log read mode**
-  - Takes a log file which created by itself (json files), reads posts and tries downloading them again.
-  - Running log read mode for FAILED.json file once after the download is complete is **HIGHLY** recommended as unexpected problems may occur.
-
-## Running the script
-**DO NOT** let more than one instance of the script run as it interferes with IMGUR Request Rate.  
-  
-### Using the command line arguments
-If no arguments are passed program will prompt you for arguments below which means you may start up the script with double-clicking on it (at least on Windows for sure).
-  
-Open up the [terminal](https://www.reddit.com/r/NSFW411/comments/8vtnl8/meta_i_made_reddit_downloader_that_can_download/e1rnbnl) and navigate to where script.py is. If you are unfamiliar with changing directories in terminal see Change Directories in [this article](https://lifehacker.com/5633909/who-needs-a-mouse-learn-to-use-the-command-line-for-almost-anything).
-  
-Run the script.py file from terminal with command-line arguments. Here is the help page:  
-  
-Use `.\` for current directory and `..\` for upper directory when using short directories, otherwise it might act weird.
-
-```console
-$ py -3 script.py --help
-usage: script.py [-h] [--link link] [--saved] [--submitted] [--upvoted]
-                 [--log LOG FILE] [--subreddit SUBREDDIT [SUBREDDIT ...]]
-                 [--multireddit MULTIREDDIT] [--user redditor]
-                 [--search query] [--sort SORT TYPE] [--limit Limit]
-                 [--time TIME_LIMIT] [--NoDownload]
-                 DIRECTORY
-
-This program downloads media from reddit posts
-
-positional arguments:
-  DIRECTORY             Specifies the directory where posts will be downloaded
-                        to
-
-optional arguments:
-  -h, --help            show this help message and exit
-  --link link, -l link  Get posts from link
-  --saved               Triggers saved mode
-  --submitted           Gets posts of --user
-  --upvoted             Gets upvoted posts of --user
-  --log LOG FILE        Triggers log read mode and takes a log file
-  --subreddit SUBREDDIT [SUBREDDIT ...]
-                        Triggers subreddit mode and takes subreddit's name
-                        without r/. use "frontpage" for frontpage
-  --multireddit MULTIREDDIT
-                        Triggers multireddit mode and takes multireddit's name
-                        without m/
-  --user redditor       reddit username if needed. use "me" for current user
-  --search query        Searches for given query in given subreddits
-  --sort SORT TYPE      Either hot, top, new, controversial, rising or
-                        relevance default: hot
-  --limit Limit         default: unlimited
-  --time TIME_LIMIT     Either hour, day, week, month, year or all. default:
-                        all
-  --NoDownload          Just gets the posts and store them in a file for
-                        downloading later
-```  
-
-### Examples
-
-#### Don't include `py -3 script.py` part if you start the script by double-clicking
-
-```console
-py -3 script.py .\\NEW_FOLDER --sort new --time all --limit 10 --link "https://www.reddit.com/r/gifs/search?q=dogs&restrict_sr=on&type=link&sort=new&t=month"
-```
-
-```console
-py -3 script.py .\\NEW_FOLDER --link "https://www.reddit.com/r/learnprogramming/comments/7mjw12/"
-```
-
-```console
-py -3 script.py .\\NEW_FOLDER --search cats --sort new --time all --subreddit gifs pics --NoDownload
-```
-
-```console
-py -3 script.py .\\NEW_FOLDER --user [USER_NAME] --submitted --limit 10
-```
-
-```console
-py -3 script.py .\\NEW_FOLDER --multireddit good_subs --user [USER_NAME] --sort top --time week --limit 250
-```
-
-```console
-py -3 script.py .\\NEW_FOLDER\\ANOTHER_FOLDER --saved --limit 1000
-```
-
-```console
-py -3 script.py C:\\NEW_FOLDER\\ANOTHER_FOLDER --log UNNAMED_FOLDER\\FAILED.json
-```
+\* Select **OAuth 2 authorization without a callback URL** first then select **Anonymous usage without user authorization** if it says *Authorization callback URL: required*
 
 ## FAQ
-### I can't startup the script no matter what.
-- Try `python3` or `python` or `py -3` as python have real issues about naming their program
+### What do the dots resemble when getting posts?
+- Each dot means that 100 posts are scanned. 
+  
+### Getting posts is taking too long.
+- You can press Ctrl+C to interrupt it and start downloading.
+  
+### How downloaded files' names are formatted?
+- Images that are not belong to an album or self posts are formatted as **`[SUBMITTER NAME]_[POST TITLE]_[REDDIT ID]`**.
+  You can use *reddit id* to go to post's reddit page by going to link **reddit.com/[REDDIT ID]**
+  
+- An image in an imgur album is formatted as **`[ITEM NUMBER]_[IMAGE TITLE]_[IMGUR ID]`**
+  Similarly, you can use *imgur id* to go to image's imgur page by going to link **imgur.com/[IMGUR ID]**.
 
-### I can't open the self posts.
-- Self posts are held at subreddit as Markdown. So, the script downloads them as Markdown in order not to lose their stylings. However, there is a great Chrome extension [here](https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk) for viewing Markdown files with its styling. Install it and open the files with Chrome.
+### How do I open self post files?
+- Self posts are held at reddit as styled with markdown. So, the script downloads them as they are in order not to lose their stylings.
+  However, there is a [great Chrome extension](https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk) for viewing Markdown files with its styling. Install it and open the files with [Chrome](https://www.google.com/intl/tr/chrome/).  
 
-## Changelog
-### 10/07/2018
+  However, they are basically text files. You can also view them with any text editor such as Notepad on Windows, gedit on Linux or Text Editor on MacOS
+
+### How can I change my credentials?
+- All of the user data is held in **config.json** file which is in a folder named "Bulk Downloader for Reddit" in your **Home** directory. You can edit 
+  them, there.
+
+## Changes on *master*
+### [25/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/1623722138bad80ae39ffcd5fb38baf80680deac)
+- Added verbose mode
+- Stylize the console output
+
+### [24/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/7a68ff3efac9939f9574c2cef6184b92edb135f4)
+- Added OP's name to file names (backwards compatible)
+- Deleted # char from file names (backwards compatible)
+- Improved exception handling
+
+### [23/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/7314e17125aa78fd4e6b28e26fda7ec7db7e0147)
+- Split download() function
+- Added erome support
+- Remove exclude feature
+- Bug fix
+
+### [22/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/a67da461d2fcd70672effcb20c8179e3224091bb)
+- Put log files in a folder named "LOG_FILES"
+- Fixed the bug that makes multireddit mode unusable
+
+### [21/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/4a8c2377f9fb4d60ed7eeb8d50aaf9a26492462a)
+- Added exclude mode
+
+### [20/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/commit/7548a010198fb693841ca03654d2c9bdf5742139)
+- "0" input for no limit
+- Fixed the bug that recognizes none image direct links as image links
+
+### [19/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/41cbb58db34f500a8a5ecc3ac4375bf6c3b275bb)
+- Added v.redd.it support
+- Added custom exception descriptions to FAILED.json file
+- Fixed the bug that prevents downloading some gfycat URLs
+
+### [13/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/9f831e1b784a770c82252e909462871401a05c11)
+- Change config.json file's path to home directory
+
+### [12/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/50a77f6ba54c24f5647d5ea4e177400b71ff04a7)
+- Added binaries for Windows and Linux
+- Wait on KeyboardInterrupt
+- Accept multiple subreddit input
+- Fixed the bug that prevents choosing "[0] exit" with typing "exit"
+
+### [11/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/a28a7776ab826dea2a8d93873a94cd46db3a339b)
+- Improvements on UX and UI
+- Added logging errors to CONSOLE_LOG.txt
+- Using current directory if directory has not been given yet.
+
+### [10/07/2018](https://github.com/aliparlakci/bulk-downloader-for-reddit/tree/ffe3839aee6dc1a552d95154d817aefc2b66af81)
 - Added support for *self* post
 - Now getting posts is quicker

_config.yml

@@ -1,5 +0,0 @@
-theme: jekyll-theme-minimal
-show_downloads: false
-#title: Bulk Downloader for Reddit
-description: Code written by     Ali PARLAKCI
-google_analytics: UA-80780721-3

docs/COMMAND_LINE_ARGUMENTS.md

@@ -0,0 +1,100 @@
+# Using command-line arguments
+
+See **[compiling from source](COMPILE_FROM_SOURCE.md)** page first unless you are using an executable file. If you are using an executable file, see [using terminal](COMPILE_FROM_SOURCE.md#using-terminal) and come back.
+
+***Use*** `.\bulk-downloader-for-reddit.exe` ***or*** `./bulk-downloader-for-reddit` ***if you are using the executable***.
+```console
+$ python script.py --help
+usage: script.py [-h] [--directory DIRECTORY] [--link link] [--saved]
+                 [--submitted] [--upvoted] [--log LOG FILE]
+                 [--subreddit SUBREDDIT [SUBREDDIT ...]]
+                 [--multireddit MULTIREDDIT] [--user redditor]
+                 [--search query] [--sort SORT TYPE] [--limit Limit]
+                 [--time TIME_LIMIT] [--NoDownload] [--verbose]
+
+This program downloads media from reddit posts
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --directory DIRECTORY, -d DIRECTORY
+                        Specifies the directory where posts will be downloaded
+                        to
+  --link link, -l link  Get posts from link
+  --saved               Triggers saved mode
+  --submitted           Gets posts of --user
+  --upvoted             Gets upvoted posts of --user
+  --log LOG FILE        Takes a log file which created by itself (json files),
+                        reads posts and tries downloading them again.
+  --subreddit SUBREDDIT [SUBREDDIT ...]
+                        Triggers subreddit mode and takes subreddit's name
+                        without r/. use "frontpage" for frontpage
+  --multireddit MULTIREDDIT
+                        Triggers multireddit mode and takes multireddit's name
+                        without m/
+  --user redditor       reddit username if needed. use "me" for current user
+  --search query        Searches for given query in given subreddits
+  --sort SORT TYPE      Either hot, top, new, controversial, rising or
+                        relevance default: hot
+  --limit Limit         default: unlimited
+  --time TIME_LIMIT     Either hour, day, week, month, year or all. default:
+                        all
+  --NoDownload          Just gets the posts and store them in a file for
+                        downloading later
+  --verbose, -v         Verbose Mode
+```
+
+# Examples
+
+- **Use `python3` instead of `python` if you are using *MacOS* or *Linux***  
+
+```console
+python script.py
+```
+
+```console
+.\bulk-downloader-for-reddit.exe
+```
+
+```console
+python script.py
+```
+
+```console
+.\bulk-downloader-for-reddit.exe -- directory .\\NEW_FOLDER --search cats --sort new --time all --subreddit gifs pics --NoDownload
+```
+
+```console
+./bulk-downloader-for-reddit --directory .\\NEW_FOLDER\\ANOTHER_FOLDER --saved --limit 1000
+```
+
+```console
+python script.py --directory .\\NEW_FOLDER --sort new --time all --limit 10 --link "https://www.reddit.com/r/gifs/search?q=dogs&restrict_sr=on&type=link&sort=new&t=month"
+```
+
+```console
+python script.py --directory .\\NEW_FOLDER --link "https://www.reddit.com/r/learnprogramming/comments/7mjw12/"
+```
+
+```console
+python script.py --directory .\\NEW_FOLDER --search cats --sort new --time all --subreddit gifs pics --NoDownload
+```
+
+```console
+python script.py --directory .\\NEW_FOLDER --user [USER_NAME] --submitted --limit 10
+```
+
+```console
+python script.py --directory .\\NEW_FOLDER --multireddit good_subs --user [USER_NAME] --sort top --time week --limit 250
+```
+
+```console
+python script.py --directory .\\NEW_FOLDER\\ANOTHER_FOLDER --saved --limit 1000
+```
+
+```console
+python script.py --directory C:\\NEW_FOLDER\\ANOTHER_FOLDER --log UNNAMED_FOLDER\\FAILED.json
+```
+
+# FAQ
+## I can't startup the script no matter what.
+See **[finding the correct keyword for Python](COMPILE_FROM_SOURCE.md#finding-the-correct-keyword-for-python)**

docs/COMPILE_FROM_SOURCE.md

@@ -0,0 +1,42 @@
+# Compiling from source code
+## Requirements
+### Python 3 Interpreter
+Latest* version of **Python 3** is needed. See if it is already installed [here](#finding-the-correct-keyword-for-python). If not, download the matching release for your platform [here](https://www.python.org/downloads/) and install it. If you are a *Windows* user, selecting **Add Python 3 to PATH** option is mandatory.   
+  
+\* *Use Python 3.6.5 if you encounter an issue*
+## Using terminal
+### To open it...
+- **On Windows 8/8.1/10**: Press the File tab on **Windows Explorer**, click on **Open Windows PowerShell** or **Open Windows Command Prompt** or look for *Command Prompt* or *PowerShell* in *Start Menu*.
+  
+- **On Windows 7**: Press **WindowsKey+R**, type **cmd** and hit Enter or look for *Command Prompt* or *PowerShell* in *Start Menu*.
+  
+- **On Linux**: Right-click in a folder and select **Open Terminal** or press **Ctrl+Alt+T** or look for **Terminal** in the programs.
+  
+- **On MacOS**: Look for an app called **Terminal**.
+  
+### Navigating to the directory where script is downloaded
+Go inside the folder where script.py is located. If you are not familiar with changing directories on command-prompt and terminal read *Changing Directories* in [this article](https://lifehacker.com/5633909/who-needs-a-mouse-learn-to-use-the-command-line-for-almost-anything)
+
+## Finding the correct keyword for Python
+Enter these lines to terminal window until it prints out the version you have downloaded and installed:
+  
+- `python --version`
+- `python3 --version`
+- `python3.7 --version`
+- `python3.6 --version`
+- `py --version`
+- `py -3 --version`
+- `py -3.6 --version`
+- `py -3.7 --version`
+  
+Once it does, your keyword is without the `--version` part. 
+
+## Installing dependencies
+Enter the line below to terminal window when you are in the directory where script.py is, use your keyword for Python:
+```console
+python -m pip install -r requirements.txt
+```
+  
+---
+  
+Now, you can go to [Using command-line arguments](COMMAND_LINE_ARGUMENTS.md)

requirements.txt

@@ -0,0 +1,3 @@
+requests
+praw
+imgurpython

script.py

@@ -6,30 +6,26 @@ saved posts from a reddit account. It is written in Python 3.
 """
 
 import argparse
+import logging
 import os
 import sys
 import time
+from io import StringIO
 from pathlib import Path, PurePath
 
-from src.downloader import Direct, Gfycat, Imgur, Self
+from src.downloader import Direct, Gfycat, Imgur, Self, Erome
+from src.errors import *
 from src.parser import LinkDesigner
 from src.searcher import getPosts
 from src.tools import (GLOBAL, createLogFile, jsonFile, nameCorrector,
                        printToFile)
-from src.errors import *
 
 __author__ = "Ali Parlakci"
 __license__ = "GPL"
-__version__ = "1.0.0"
+__version__ = "1.5.2"
 __maintainer__ = "Ali Parlakci"
 __email__ = "parlakciali@gmail.com"
 
-def debug(*post):
-    GLOBAL.config = getConfig('config.json')
-    GLOBAL.directory = Path(".\\debug\\")
-    download([*post])
-    quit()
-
 def getConfig(configFileName):
     """Read credentials from config.json file"""
 
@@ -66,7 +62,7 @@ def parseArguments(arguments=[]):
                                      description="This program downloads " \
                                                  "media from reddit " \
                                                  "posts")
-    parser.add_argument("directory",
+    parser.add_argument("--directory","-d",
                         help="Specifies the directory where posts will be " \
                         "downloaded to",
                         metavar="DIRECTORY")
@@ -88,7 +84,9 @@ def parseArguments(arguments=[]):
                         help="Gets upvoted posts of --user")
 
     parser.add_argument("--log",
-                        help="Triggers log read mode and takes a log file",
+                        help="Takes a log file which created by itself " \
+                             "(json files), reads posts and tries downloadin" \
+                             "g them again.",
                         # type=argparse.FileType('r'),
                         metavar="LOG FILE")
 
@@ -131,7 +129,6 @@ def parseArguments(arguments=[]):
     parser.add_argument("--limit",
                         help="default: unlimited",
                         metavar="Limit",
-                        default=None,
                         type=int)
 
     parser.add_argument("--time",
@@ -146,6 +143,12 @@ def parseArguments(arguments=[]):
                              " for downloading later",
                         action="store_true",
                         default=False)
+    
+    parser.add_argument("--verbose","-v",
+                        help="Verbose Mode",
+                        action="store_true",
+                        default=False)
+    
 
     if arguments == []:
         return parser.parse_args()
@@ -157,88 +160,181 @@ def checkConflicts():
     if not, raise errors
     """
 
-    if GLOBAL.arguments.saved is False:
-        saved = 0
-    else: 
-        saved = 1
-
-    if GLOBAL.arguments.subreddit is None:
-        subreddit = 0
-    else:
-        subreddit = 1
-
-    if GLOBAL.arguments.submitted is False:
-        submitted = 0
-    else:
-        submitted = 1
-    
-    if GLOBAL.arguments.search is None:
-        search = 0
-    else:
-        search = 1
-
-    if GLOBAL.arguments.log is None:
-        log = 0
-    else:
-        log = 1
-
-    if GLOBAL.arguments.link is None:
-        link = 0
-    else:
-        link = 1
-
     if GLOBAL.arguments.user is None:
         user = 0
     else:
         user = 1
 
-    if GLOBAL.arguments.upvoted is False:
-        upvoted = 0
-    else:
-        upvoted = 1
+    modes = [
+        "saved","subreddit","submitted","search","log","link","upvoted",
+        "multireddit"
+    ]
 
-    if not saved+subreddit+log+link+submitted+upvoted == 1:
-        print("Program mode is invalid")
-        quit()
+    values = {
+        x: 0 if getattr(GLOBAL.arguments,x) is None or \
+                getattr(GLOBAL.arguments,x) is False \
+             else 1 \
+             for x in modes
+    }
+
+    if not sum(values[x] for x in values) == 1:
+        raise ProgramModeError("Invalid program mode")
     
-    if search+subreddit == 2:
-        print("You cannot search in your saved posts")
-        quit()
+    if values["search"]+values["saved"] == 2:
+        raise SearchModeError("You cannot search in your saved posts")
 
-    if search+submitted == 2:
-        print("You cannot search in submitted posts")
-        quit()
+    if values["search"]+values["submitted"] == 2:
+        raise SearchModeError("You cannot search in submitted posts")
 
-    if search+upvoted == 2:
-        print("You cannot search in upvoted posts")
-        quit()
+    if values["search"]+values["upvoted"] == 2:
+        raise SearchModeError("You cannot search in upvoted posts")
 
-    if upvoted+submitted == 1 and user == 0:
-        print("No redditor name given")
-        quit()
+    if values["upvoted"]+values["submitted"] == 1 and user == 0:
+        raise RedditorNameError("No redditor name given")
 
-def postFromLog(fileName):
-    """Analyze a log file and return a list of dictionaries containing
-    submissions
-    """
-    if Path.is_file(Path(fileName)):
-        content = jsonFile(fileName).read()
-    else:
-        print("File not found")
-        quit()
+class PromptUser:
+    @staticmethod
+    def chooseFrom(choices):
+        print()
+        choicesByIndex = list(str(x) for x in range(len(choices)+1))
+        for i in range(len(choices)):
+            print("{indent}[{order}] {mode}".format(
+                indent=" "*4,order=i+1,mode=choices[i]
+            ))
+        print(" "*4+"[0] exit\n")
+        choice = input("> ")
+        while not choice.lower() in choices+choicesByIndex+["exit"]:
+            print("Invalid input\n")
+            programModeIndex = input("> ")
 
-    try:
-        del content["HEADER"]
-    except KeyError:
-        pass
+        if choice == "0" or choice == "exit":
+            sys.exit()
+        elif choice in choicesByIndex:
+            return choices[int(choice)-1]
+        else:
+            return choice
+    
+    def __init__(self):
+        print("select program mode:")
+        programModes = [
+            "search","subreddit","multireddit",
+            "submitted","upvoted","saved","log"
+        ]
+        programMode = self.chooseFrom(programModes)
 
-    posts = []
+        if programMode == "search":
+            GLOBAL.arguments.search = input("\nquery: ")
+            GLOBAL.arguments.subreddit = input("\nsubreddit: ")
 
-    for post in content:
-        if not content[post][-1]['postType'] == None:
-            posts.append(content[post][-1])
+            print("\nselect sort type:")
+            sortTypes = [
+                "relevance","top","new"
+            ]
+            sortType = self.chooseFrom(sortTypes)
+            GLOBAL.arguments.sort = sortType
 
-    return posts
+            print("\nselect time filter:")
+            timeFilters = [
+                "hour","day","week","month","year","all"
+            ]
+            timeFilter = self.chooseFrom(timeFilters)
+            GLOBAL.arguments.time = timeFilter
+
+        if programMode == "subreddit":
+
+            subredditInput = input("subreddit (enter frontpage for frontpage): ")
+            GLOBAL.arguments.subreddit = subredditInput
+
+            while not (subredditInput == "" or subredditInput.lower() == "frontpage"):
+                subredditInput = input("subreddit: ")
+                GLOBAL.arguments.subreddit += "+" + subredditInput
+
+            if " " in GLOBAL.arguments.subreddit:
+                GLOBAL.arguments.subreddit = "+".join(GLOBAL.arguments.subreddit.split())
+
+            # DELETE THE PLUS (+) AT THE END
+            if not subredditInput.lower() == "frontpage":
+                GLOBAL.arguments.subreddit = GLOBAL.arguments.subreddit[:-1]
+
+            print("\nselect sort type:")
+            sortTypes = [
+                "hot","top","new","rising","controversial"
+            ]
+            sortType = self.chooseFrom(sortTypes)
+            GLOBAL.arguments.sort = sortType
+
+            if sortType in ["top","controversial"]:
+                print("\nselect time filter:")
+                timeFilters = [
+                    "hour","day","week","month","year","all"
+                ]
+                timeFilter = self.chooseFrom(timeFilters)
+                GLOBAL.arguments.time = timeFilter
+            else:
+                GLOBAL.arguments.time = "all"
+
+        elif programMode == "multireddit":
+            GLOBAL.arguments.user = input("\nredditor: ")
+            GLOBAL.arguments.multireddit = input("\nmultireddit: ")
+            
+            print("\nselect sort type:")
+            sortTypes = [
+                "hot","top","new","rising","controversial"
+            ]
+            sortType = self.chooseFrom(sortTypes)
+            GLOBAL.arguments.sort = sortType
+
+            if sortType in ["top","controversial"]:
+                print("\nselect time filter:")
+                timeFilters = [
+                    "hour","day","week","month","year","all"
+                ]
+                timeFilter = self.chooseFrom(timeFilters)
+                GLOBAL.arguments.time = timeFilter
+            else:
+                GLOBAL.arguments.time = "all"
+        
+        elif programMode == "submitted":
+            GLOBAL.arguments.submitted = True
+            GLOBAL.arguments.user = input("\nredditor: ")
+
+            print("\nselect sort type:")
+            sortTypes = [
+                "hot","top","new","controversial"
+            ]
+            sortType = self.chooseFrom(sortTypes)
+            GLOBAL.arguments.sort = sortType
+
+            if sortType == "top":
+                print("\nselect time filter:")
+                timeFilters = [
+                    "hour","day","week","month","year","all"
+                ]
+                timeFilter = self.chooseFrom(timeFilters)
+                GLOBAL.arguments.time = timeFilter
+            else:
+                GLOBAL.arguments.time = "all"
+        
+        elif programMode == "upvoted":
+            GLOBAL.arguments.upvoted = True
+            GLOBAL.arguments.user = input("\nredditor: ")
+        
+        elif programMode == "saved":
+            GLOBAL.arguments.saved = True
+        
+        elif programMode == "log":
+            while True:
+                GLOBAL.arguments.log = input("\nlog file directory:")
+                if Path(GLOBAL.arguments.log ).is_file():
+                    break 
+        while True:
+            try:
+                GLOBAL.arguments.limit = int(input("\nlimit (0 for none): "))
+                if GLOBAL.arguments.limit == 0:
+                    GLOBAL.arguments.limit = None
+                break
+            except ValueError:
+                pass
 
 def prepareAttributes():
     ATTRIBUTES = {}
@@ -285,10 +381,14 @@ def prepareAttributes():
             ATTRIBUTES["time"] = GLOBAL.arguments.time
 
     elif GLOBAL.arguments.subreddit is not None:
-        GLOBAL.arguments.subreddit = "+".join(GLOBAL.arguments.subreddit)
+        if type(GLOBAL.arguments.subreddit) == list:    
+            GLOBAL.arguments.subreddit = "+".join(GLOBAL.arguments.subreddit)
 
         ATTRIBUTES["subreddit"] = GLOBAL.arguments.subreddit
 
+    elif GLOBAL.arguments.multireddit is not None:
+        ATTRIBUTES["multireddit"] = GLOBAL.arguments.multireddit
+
     elif GLOBAL.arguments.saved is True:
         ATTRIBUTES["saved"] = True
 
@@ -305,75 +405,96 @@ def prepareAttributes():
 
     return ATTRIBUTES
 
-def postExists(POST):
+def postFromLog(fileName):
+    """Analyze a log file and return a list of dictionaries containing
+    submissions
+    """
+    if Path.is_file(Path(fileName)):
+        content = jsonFile(fileName).read()
+    else:
+        print("File not found")
+        sys.exit()
+
+    try:
+        del content["HEADER"]
+    except KeyError:
+        pass
+
+    posts = []
+
+    for post in content:
+        if not content[post][-1]['postType'] == None:
+            posts.append(content[post][-1])
+
+    return posts
+
+def isPostExists(POST):
     """Figure out a file's name and checks if the file already exists"""
 
     title = nameCorrector(POST['postTitle'])
-    FILENAME = title + "_" + POST['postId']
     PATH = GLOBAL.directory / POST["postSubreddit"]
-    possibleExtensions = [".jpg",".png",".mp4",".gif",".webm"]
 
-    for i in range(2):
-        for extension in possibleExtensions:
-            FILE_PATH = PATH / (FILENAME+extension)
-            if FILE_PATH.exists():
-                return True
-        else:
-            FILENAME = POST['postId']
+    possibleExtensions = [".jpg",".png",".mp4",".gif",".webm",".md"]
+
+    for extension in possibleExtensions:
+
+        OLD_FILE_PATH = PATH / (
+            title
+            + "_" + POST['postId']
+            + extension
+        )
+        FILE_PATH = PATH / (
+            POST["postSubmitter"] 
+            + "_" + title 
+            + "_" + POST['postId'] 
+            + extension
+        )
+
+        SHORT_FILE_PATH = PATH / (POST['postId']+extension)
+
+        if OLD_FILE_PATH.exists() or \
+           FILE_PATH.exists() or \
+           SHORT_FILE_PATH.exists():
+           
+            return True
+
     else:
         return False
 
-def download(submissions):
-    """Analyze list of submissions and call the right function
-    to download each one, catch errors, update the log files
-    """
+def downloadPost(SUBMISSION):
+    directory = GLOBAL.directory / SUBMISSION['postSubreddit']
 
-    subsLenght = len(submissions)
-    lastRequestTime = 0
-    downloadedCount = subsLenght
-    duplicates = 0
-    BACKUP = {}
+    global lastRequestTime
 
-    FAILED_FILE = createLogFile("FAILED")
+    downloaders = {
+        "imgur":Imgur,"gfycat":Gfycat,"erome":Erome,"direct":Direct,"self":Self
+    }
 
-    for i in range(subsLenght):
-        print("\n({}/{})".format(i+1,subsLenght))
-        print(
-            "https://reddit.com/r/{subreddit}/comments/{id}".format(
-                subreddit=submissions[i]['postSubreddit'],
-                id=submissions[i]['postId']
-            )
-        )
+    print()
+    if SUBMISSION['postType'] in downloaders:
 
-        if postExists(submissions[i]):
-            result = False
-            print("It already exists")
-            duplicates += 1
-            downloadedCount -= 1
-            continue
-
-        directory = GLOBAL.directory / submissions[i]['postSubreddit']
-
-        if submissions[i]['postType'] == 'imgur':
-            print("IMGUR",end="")
+        if SUBMISSION['postType'] == "imgur":
             
             while int(time.time() - lastRequestTime) <= 2:
                 pass
+
             credit = Imgur.get_credits()
 
             IMGUR_RESET_TIME = credit['UserReset']-time.time()
             USER_RESET = ("after " \
-                          + str(int(IMGUR_RESET_TIME/60)) \
-                          + " Minutes " \
-                          + str(int(IMGUR_RESET_TIME%60)) \
-                          + " Seconds") 
-            print(
-                " => Client: {} - User: {} - Reset {}".format(
-                    credit['ClientRemaining'],
-                    credit['UserRemaining'],
-                    USER_RESET
+                            + str(int(IMGUR_RESET_TIME/60)) \
+                            + " Minutes " \
+                            + str(int(IMGUR_RESET_TIME%60)) \
+                            + " Seconds") 
+
+            if credit['ClientRemaining'] < 25 or credit['UserRemaining'] < 25:
+                print(
+                    "==> Client: {} - User: {} - Reset {}".format(
+                        credit['ClientRemaining'],
+                        credit['UserRemaining'],
+                        USER_RESET
+                    ),end=""
                 )
-            )
 
             if not (credit['UserRemaining'] == 0 or \
                     credit['ClientRemaining'] == 0):
@@ -382,94 +503,105 @@ def download(submissions):
                 """
                 while int(time.time() - lastRequestTime) <= 2:
                     pass
+
                 lastRequestTime = time.time()
 
-                try:
-                    Imgur(directory,submissions[i])
-
-                except FileAlreadyExistsError:
-                    print("It already exists")
-                    duplicates += 1
-                    downloadedCount -= 1
-
-                except ImgurLoginError:
-                    print(
-                        "Imgur login failed. Quitting the program "\
-                        "as unexpected errors might occur."
-                    )
-                    quit()
-
-                except Exception as exception:
-                    print(exception)
-                    FAILED_FILE.add({int(i+1):[str(exception),submissions[i]]})
-                    downloadedCount -= 1
-
             else:
                 if credit['UserRemaining'] == 0:
                     KEYWORD = "user"
                 elif credit['ClientRemaining'] == 0:
                     KEYWORD = "client"
 
-                print('{} LIMIT EXCEEDED\n'.format(KEYWORD.upper()))
-                FAILED_FILE.add(
-                    {int(i+1):['{} LIMIT EXCEEDED\n'.format(KEYWORD.upper()),
-                               submissions[i]]}
-                )
-                downloadedCount -= 1
+                raise ImgurLimitError('{} LIMIT EXCEEDED\n'.format(KEYWORD.upper()))
 
-        elif submissions[i]['postType'] == 'gfycat':
-            print("GFYCAT")
-            try:
-                Gfycat(directory,submissions[i])
+        downloaders[SUBMISSION['postType']] (directory,SUBMISSION)
 
-            except FileAlreadyExistsError:
-                print("It already exists")
-                duplicates += 1
-                downloadedCount -= 1
-                
-            except NotADownloadableLinkError as exception:
-                print("Could not read the page source")
-                FAILED_FILE.add({int(i+1):[str(exception),submissions[i]]})
-                downloadedCount -= 1
+    else:
+        raise NoSuitablePost
 
-            except Exception as exception:
-                print(exception)
-                FAILED_FILE.add({int(i+1):[str(exception),submissions[i]]})
-                downloadedCount -= 1
+    return None
 
-        elif submissions[i]['postType'] == 'direct':
-            print("DIRECT")
-            try:
-                Direct(directory,submissions[i])
+def download(submissions):
+    """Analyze list of submissions and call the right function
+    to download each one, catch errors, update the log files
+    """
 
-            except FileAlreadyExistsError:
-                print("It already exists")
-                downloadedCount -= 1
-                duplicates += 1
+    subsLenght = len(submissions)
+    global lastRequestTime
+    lastRequestTime = 0
+    downloadedCount = subsLenght
+    duplicates = 0
 
-            except Exception as exception:
-                print(exception)
-                FAILED_FILE.add({int(i+1):[str(exception),submissions[i]]})
-                downloadedCount -= 1
+    FAILED_FILE = createLogFile("FAILED")
+
+    for i in range(subsLenght):
+        print(
+            f"\n({i+1}/{subsLenght}) ({submissions[i]['postType'].upper()}) " \
+            f"(r/{submissions[i]['postSubreddit']})",end=""
+        )
+
+        if isPostExists(submissions[i]):
+            print("\nIt already exists")
+            duplicates += 1
+            downloadedCount -= 1
+            continue
+
+        try:
+            downloadPost(submissions[i])
         
-        elif submissions[i]['postType'] == 'self':
-            print("SELF")
-            try:
-                Self(directory,submissions[i])
+        except FileAlreadyExistsError:
+            print("It already exists")
+            duplicates += 1
+            downloadedCount -= 1
 
-            except FileAlreadyExistsError:
-                print("It already exists")
-                downloadedCount -= 1
-                duplicates += 1
+        except ImgurLoginError:
+            print(
+                "Imgur login failed. \nQuitting the program "\
+                "as unexpected errors might occur."
+            )
+            sys.exit()
 
-            except Exception as exception:
-                print(exception)
-                FAILED_FILE.add({int(i+1):[str(exception),submissions[i]]})
-                downloadedCount -= 1
+        except ImgurLimitError as exception:
+            FAILED_FILE.add({int(i+1):[
+                "{class_name}: {info}".format(
+                    class_name=exception.__class__.__name__,info=str(exception)
+                ),
+                submissions[i]
+            ]})
+            downloadedCount -= 1
 
-        else:
+        except NotADownloadableLinkError as exception:
+            print(
+                "{class_name}: {info}".format(
+                    class_name=exception.__class__.__name__,info=str(exception)
+                )
+            )
+            FAILED_FILE.add({int(i+1):[
+                "{class_name}: {info}".format(
+                    class_name=exception.__class__.__name__,info=str(exception)
+                ),
+                submissions[i]
+            ]})
+            downloadedCount -= 1
+
+        except NoSuitablePost:
             print("No match found, skipping...")
             downloadedCount -= 1
+        
+        except Exception as exception:
+            # raise exception
+            print(
+                "{class_name}: {info}".format(
+                    class_name=exception.__class__.__name__,info=str(exception)
+                )
+            )
+            FAILED_FILE.add({int(i+1):[
+                "{class_name}: {info}".format(
+                    class_name=exception.__class__.__name__,info=str(exception)
+                ),
+                submissions[i]
+            ]})
+            downloadedCount -= 1
 
     if duplicates:
         print("\n There was {} duplicates".format(duplicates))
@@ -481,66 +613,83 @@ def download(submissions):
         print(" Total of {} links downloaded!".format(downloadedCount))
 
 def main():
-    if sys.argv[-1].endswith(__file__):
-        GLOBAL.arguments = parseArguments(input("> ").split())
-    else:
-        GLOBAL.arguments = parseArguments()
+    GLOBAL.arguments = parseArguments()
+
     if GLOBAL.arguments.directory is not None:
         GLOBAL.directory = Path(GLOBAL.arguments.directory)
     else:
-        print("Invalid directory")
-        quit()
-    GLOBAL.config = getConfig(Path(PurePath(__file__).parent / 'config.json'))
+        GLOBAL.directory = Path(input("download directory: "))
 
-    checkConflicts()
+    print("\n"," ".join(sys.argv),"\n")
 
-    print(sys.argv)
+    try:
+        checkConflicts()
+    except ProgramModeError as err:
+        PromptUser()
+
+    if not Path(GLOBAL.configDirectory).is_dir():
+        os.makedirs(GLOBAL.configDirectory)
+    GLOBAL.config = getConfig(GLOBAL.configDirectory / "config.json")
 
     if GLOBAL.arguments.log is not None:
         logDir = Path(GLOBAL.arguments.log)
         download(postFromLog(logDir))
-        quit()
-
+        sys.exit()
+    
     try:
         POSTS = getPosts(prepareAttributes())
     except InsufficientPermission:
         print("You do not have permission to do that")
-        quit()
+        sys.exit()
     except NoMatchingSubmissionFound:
         print("No matching submission was found")
-        quit()
+        sys.exit()
     except NoRedditSupoort:
         print("Reddit does not support that")
-        quit()
+        sys.exit()
     except NoPrawSupport:
         print("PRAW does not support that")
-        quit()
+        sys.exit()
     except MultiredditNotFound:
         print("Multireddit not found")
-        quit()
+        sys.exit()
     except InvalidSortingType:
         print("Invalid sorting type has given")
-        quit()
+        sys.exit()
     except InvalidRedditLink:
         print("Invalid reddit link")
-        quit()
+        sys.exit()
 
     if POSTS is None:
         print("I could not find any posts in that URL")
-        quit()
+        sys.exit()
 
     if GLOBAL.arguments.NoDownload:
-        quit()
+        sys.exit()
 
     else:
         download(POSTS)
 
 if __name__ == "__main__":
+
+    log_stream = StringIO()    
+    logging.basicConfig(stream=log_stream, level=logging.INFO)
+
     try:
         VanillaPrint = print
         print = printToFile
         GLOBAL.RUN_TIME = time.time()
         main()
+
     except KeyboardInterrupt:
-        print("\nQUITTING...")
-        quit()
+        if GLOBAL.directory is None:
+            GLOBAL.directory = Path(".\\")
+        
+    except Exception as exception:
+        if GLOBAL.directory is None:
+            GLOBAL.directory = Path(".\\")
+        logging.error(sys.exc_info()[0].__name__,
+                      exc_info=full_exc_info(sys.exc_info()))
+        print(log_stream.getvalue())
+
+    input("\nPress enter to quit\n")

setup.py

@@ -0,0 +1,50 @@
+#!C:\Users\Ali\AppData\Local\Programs\Python\Python36\python.exe
+
+## python setup.py build
+import sys
+from cx_Freeze import setup, Executable
+from script import __version__
+
+options = {
+    "build_exe": {
+        "packages":[
+            "idna","imgurpython", "praw", "requests"
+        ]
+    }
+}
+
+if sys.platform == "win32":
+    executables = [Executable(
+        "script.py", 
+        targetName="bulk-downloader-for-reddit.exe",
+        shortcutName="Bulk Downloader for Reddit",
+        shortcutDir="DesktopFolder"
+    )]
+
+elif sys.platform == "linux":
+    executables = [Executable(
+        "script.py", 
+        targetName="bulk-downloader-for-reddit",
+        shortcutName="Bulk Downloader for Reddit",
+        shortcutDir="DesktopFolder"
+    )]
+
+setup(
+    name = "Bulk Downloader for Reddit",
+    version = __version__,
+    description = "Bulk Downloader for Reddit",
+    author = "Ali Parlakci",
+    author_email="parlakciali@gmail.com",
+    url="https://github.com/aliparlakci/bulk-downloader-for-reddit",
+    classifiers=(
+            "Programming Language :: Python :: 3",
+            "License :: OSI Approved :: GNU General Public License v3 (GPLv3)"
+            "Natural Language :: English",
+            "Environment :: Console",
+            "Operating System :: OS Independent",
+    ),
+    executables = executables,
+    options = options
+)
+
+

src/downloader.py

@@ -2,21 +2,18 @@ import io
 import os
 import sys
 import urllib.request
+from html.parser import HTMLParser
 from pathlib import Path
+from urllib.error import HTTPError
+
+import imgurpython
+from multiprocessing import Queue
 
 from src.errors import (AlbumNotDownloadedCompletely, FileAlreadyExistsError,
                         FileNameTooLong, ImgurLoginError,
                         NotADownloadableLinkError)
 from src.tools import GLOBAL, nameCorrector, printToFile
 
-try:
-    from imgurpython import *
-except ModuleNotFoundError:
-    print("\nimgurpython not found on your computer, installing...\n")
-    from src.tools import install
-    install("imgurpython")
-    from imgurpython import *
-
 VanillaPrint = print
 print = printToFile
 
@@ -41,7 +38,10 @@ def getExtension(link):
         if TYPE in parsed:
             return "."+parsed[-1]
     else:
-        return '.jpg'
+        if not "v.redd.it" in link:
+            return '.jpg'
+        else:
+            return '.mp4'
 
 def getFile(fileDir,tempDir,imageURL,indent=0):
     """Downloads given file to given directory.
@@ -61,16 +61,150 @@ def getFile(fileDir,tempDir,imageURL,indent=0):
                                            tempDir,
                                            reporthook=dlProgress)
                 os.rename(tempDir,fileDir)
-                print(" "*indent+"Downloaded"+" "*10)
-                break
             except ConnectionResetError as exception:
                 print(" "*indent + str(exception))
                 print(" "*indent + "Trying again\n")
             except FileNotFoundError:
                 raise FileNameTooLong
+            else:
+                print(" "*indent+"Downloaded"+" "*10)
+                break
     else:
         raise FileAlreadyExistsError
 
+class Erome:
+    def __init__(self,directory,post):
+        try:
+            IMAGES = self.getLinks(post['postURL'])
+        except urllib.error.HTTPError:
+            raise NotADownloadableLinkError("Not a downloadable link")
+
+        imagesLenght = len(IMAGES)
+        howManyDownloaded = imagesLenght
+        duplicates = 0
+
+        if imagesLenght == 1:
+            
+            extension = getExtension(IMAGES[0])
+
+            title = nameCorrector(post['postTitle'])
+            print(post["postSubmitter"]+"_"+title+"_"+post['postId']+extension)
+
+            fileDir = directory / (
+                post["postSubmitter"]+"_"+title+"_"+post['postId']+extension
+            )
+            tempDir = directory / (
+                post["postSubmitter"]+"_"+title+"_"+post['postId']+".tmp"
+            )
+
+            imageURL = "https:" + IMAGES[0]
+
+            try:
+                getFile(fileDir,tempDir,imageURL)
+            except FileNameTooLong:
+                fileDir = directory / (post['postId'] + extension)
+                tempDir = directory / (post['postId'] + '.tmp')
+                getFile(fileDir,tempDir,imageURL)
+
+        else:
+            title = nameCorrector(post['postTitle'])
+            print(post["postSubmitter"]+"_"+title+"_"+post['postId'],end="\n\n")
+
+            folderDir = directory / (
+                post["postSubmitter"] + "_" + title + "_" + post['postId']
+            )
+
+            try:
+                if not os.path.exists(folderDir):
+                    os.makedirs(folderDir)
+            except FileNotFoundError:
+                folderDir = directory / post['postId']
+                os.makedirs(folderDir)
+
+            for i in range(imagesLenght):
+                
+                extension = getExtension(IMAGES[i])
+
+                fileName = str(i+1)
+                imageURL = "https:" + IMAGES[i]
+
+                fileDir = folderDir / (fileName + extension)
+                tempDir = folderDir / (fileName + ".tmp")
+
+                print("  ({}/{})".format(i+1,imagesLenght))
+                print("  {}".format(fileName+extension))
+
+                try:
+                    getFile(fileDir,tempDir,imageURL,indent=2)
+                    print()
+                except FileAlreadyExistsError:
+                    print("  The file already exists" + " "*10,end="\n\n")
+                    duplicates += 1
+                    howManyDownloaded -= 1
+
+                except Exception as exception:
+                    # raise exception
+                    print("\n  Could not get the file")
+                    print(
+                        "  "
+                        + "{class_name}: {info}".format(
+                            class_name=exception.__class__.__name__,
+                            info=str(exception)
+                        )
+                        + "\n"
+                    )
+                    exceptionType = exception
+                    howManyDownloaded -= 1
+
+            if duplicates == imagesLenght:
+                raise FileAlreadyExistsError
+            elif howManyDownloaded + duplicates < imagesLenght:
+                raise AlbumNotDownloadedCompletely(
+                    "Album Not Downloaded Completely"
+                )
+
+    def getLinks(self,url,lineNumber=129):
+ 
+        content = []
+        lineNumber = None
+
+        class EromeParser(HTMLParser):
+            tag = None
+            def handle_starttag(self, tag, attrs):
+                self.tag = {tag:{attr[0]: attr[1] for attr in attrs}}
+
+        pageSource = (urllib.request.urlopen(url).read().decode().split('\n'))
+
+        """ FIND WHERE ALBUM STARTS IN ORDER NOT TO GET WRONG LINKS"""
+        for i in range(len(pageSource)):
+            obj = EromeParser()
+            obj.feed(pageSource[i])
+            tag = obj.tag
+            
+            if tag is not None:
+                if "div" in tag:
+                    if "id" in tag["div"]:
+                        if tag["div"]["id"] == "album":
+                            lineNumber = i
+                            break
+
+        for line in pageSource[lineNumber:]:
+            obj = EromeParser()
+            obj.feed(line)
+            tag = obj.tag
+            if tag is not None:
+                if "img" in tag:
+                    if "class" in tag["img"]:
+                        if tag["img"]["class"]=="img-front":
+                            content.append(tag["img"]["src"])
+                elif "source" in tag:
+                    content.append(tag["source"]["src"])
+                    
+        return [
+            link for link in content \
+            if link.endswith("_480p.mp4") or not link.endswith(".mp4")
+        ]
+
 class Imgur:
     def __init__(self,directory,post):
         self.imgurClient = self.initImgur()
@@ -90,13 +224,22 @@ class Imgur:
             post['postExt'] = getExtension(post['mediaURL'])
 
             title = nameCorrector(post['postTitle'])
-            print(title+"_" +post['postId']+post['postExt'])
+            print(post["postSubmitter"]+"_"+title+"_"+post['postId']+post['postExt'])
 
-            fileDir = title + "_" + post['postId'] + post['postExt']
-            fileDir = directory / fileDir
+            fileDir = directory / (
+                post["postSubmitter"]
+                + "_" + title
+                + "_" + post['postId'] 
+                + post['postExt']
+            )
+
+            tempDir = directory / (
+                post["postSubmitter"]
+                + "_" + title 
+                + "_" + post['postId'] 
+                + ".tmp"
+            )
 
-            tempDir = title + "_" + post['postId'] + '.tmp'
-            tempDir = directory / tempDir
             try:
                 getFile(fileDir,tempDir,post['mediaURL'])
             except FileNameTooLong:
@@ -112,9 +255,11 @@ class Imgur:
             duplicates = 0
 
             title = nameCorrector(post['postTitle'])
-            print(title+"_"+post['postId'],end="\n\n")
+            print(post["postSubmitter"]+"_"+title+"_"+post['postId'],end="\n\n")
 
-            folderDir = directory / (title+"_"+post['postId'])
+            folderDir = directory / (
+                post["postSubmitter"] + "_" + title + "_" + post['postId']
+            )
 
             try:
                 if not os.path.exists(folderDir):
@@ -167,21 +312,30 @@ class Imgur:
 
                 except Exception as exception:
                     print("\n  Could not get the file")
-                    print("  " + str(exception) + "\n")
+                    print(
+                        "  "
+                        + "{class_name}: {info}".format(
+                            class_name=exception.__class__.__name__,
+                            info=str(exception)
+                        )
+                        + "\n"
+                    )
                     exceptionType = exception
                     howManyDownloaded -= 1
 
             if duplicates == imagesLenght:
                 raise FileAlreadyExistsError
-            elif howManyDownloaded < imagesLenght:
-                raise AlbumNotDownloadedCompletely
+            elif howManyDownloaded + duplicates < imagesLenght:
+                raise AlbumNotDownloadedCompletely(
+                    "Album Not Downloaded Completely"
+                )
     
     @staticmethod
     def initImgur():
         """Initialize imgur api"""
 
         config = GLOBAL.config
-        return ImgurClient(
+        return imgurpython.ImgurClient(
             config['imgur_client_id'],
             config['imgur_client_secret']
         )
@@ -213,7 +367,7 @@ class Imgur:
         elif identity['type'] == 'album':
             return {'object':self.imgurClient.get_album(identity['id']),
                     'type':'album'}
-
+    @staticmethod
     def get_credits():
         return Imgur.initImgur().get_credits()
 
@@ -222,18 +376,23 @@ class Gfycat:
         try:
             POST['mediaURL'] = self.getLink(POST['postURL'])
         except IndexError:
-            raise NotADownloadableLinkError
+            raise NotADownloadableLinkError("Could not read the page source")
         except Exception as exception:
-            raise NotADownloadableLinkError
+            raise NotADownloadableLinkError("Could not read the page source")
 
         POST['postExt'] = getExtension(POST['mediaURL'])
 
         if not os.path.exists(directory): os.makedirs(directory)
         title = nameCorrector(POST['postTitle'])
-        print(title+"_"+POST['postId']+POST['postExt'])
+        print(POST["postSubmitter"]+"_"+title+"_"+POST['postId']+POST['postExt'])
 
-        fileDir = directory / (title+"_"+POST['postId']+POST['postExt'])
-        tempDir = directory / (title+"_"+POST['postId']+".tmp")
+        fileDir = directory / (
+            POST["postSubmitter"]+"_"+title+"_"+POST['postId']+POST['postExt']
+        )
+        tempDir = directory / (
+            POST["postSubmitter"]+"_"+title+"_"+POST['postId']+".tmp"
+        )
+        
         try:
             getFile(fileDir,tempDir,POST['mediaURL'])
         except FileNameTooLong:
@@ -253,8 +412,7 @@ class Gfycat:
         if url[-1:] == '/':
             url = url[:-1]
 
-        if 'gifs' in url:
-            url = "https://gfycat.com/" + url.split('/')[-1]
+        url = "https://gfycat.com/" + url.split('/')[-1]
 
         pageSource = (urllib.request.urlopen(url).read().decode().split('\n'))
 
@@ -271,7 +429,7 @@ class Gfycat:
                 break
 
         if "".join(link) == "":
-            raise NotADownloadableLinkError
+            raise NotADownloadableLinkError("Could not read the page source")
 
         return "".join(link)
 
@@ -280,13 +438,14 @@ class Direct:
         POST['postExt'] = getExtension(POST['postURL'])
         if not os.path.exists(directory): os.makedirs(directory)
         title = nameCorrector(POST['postTitle'])
-        print(title+"_"+POST['postId']+POST['postExt'])
+        print(POST["postSubmitter"]+"_"+title+"_"+POST['postId']+POST['postExt'])
 
-        fileDir = title+"_"+POST['postId']+POST['postExt']
-        fileDir = directory / fileDir
-
-        tempDir = title+"_"+POST['postId']+".tmp"
-        tempDir = directory / tempDir
+        fileDir = directory / (
+            POST["postSubmitter"]+"_"+title+"_"+POST['postId']+POST['postExt']
+        )
+        tempDir = directory / (
+            POST["postSubmitter"]+"_"+title+"_"+POST['postId']+".tmp"
+        )
 
         try:
             getFile(fileDir,tempDir,POST['postURL'])
@@ -301,10 +460,11 @@ class Self:
         if not os.path.exists(directory): os.makedirs(directory)
 
         title = nameCorrector(post['postTitle'])
-        print(title+"_"+post['postId']+".md")
+        print(post["postSubmitter"]+"_"+title+"_"+post['postId']+".md")
 
-        fileDir = title+"_"+post['postId']+".md"
-        fileDir = directory / fileDir
+        fileDir = directory / (
+            post["postSubmitter"]+"_"+title+"_"+post['postId']+".md"
+        )
         
         if Path.is_file(fileDir):
             raise FileAlreadyExistsError
@@ -327,7 +487,11 @@ class Self:
                    + ")\n"
                    + post["postContent"]
                    + "\n\n---\n\n"
-                   + "submitted by [u/"
+                   + "submitted to [r/"
+                   + post["postSubreddit"]
+                   + "](https://www.reddit.com/r/"
+                   + post["postSubreddit"]
+                   + ") by [u/"
                    + post["postSubmitter"]
                    + "](https://www.reddit.com/user/"
                    + post["postSubmitter"]

src/errors.py

@@ -1,3 +1,36 @@
+import sys
+
+class FauxTb(object):
+    def __init__(self, tb_frame, tb_lineno, tb_next):
+        self.tb_frame = tb_frame
+        self.tb_lineno = tb_lineno
+        self.tb_next = tb_next
+
+def current_stack(skip=0):
+    try: 1/0
+    except ZeroDivisionError:
+        f = sys.exc_info()[2].tb_frame
+    for i in range(skip + 2):
+        f = f.f_back
+    lst = []
+    while f is not None:
+        lst.append((f, f.f_lineno))
+        f = f.f_back
+    return lst
+
+def extend_traceback(tb, stack):
+    """Extend traceback with stack info."""
+    head = tb
+    for tb_frame, tb_lineno in stack:
+        head = FauxTb(tb_frame, tb_lineno, head)
+    return head
+
+def full_exc_info(exc_info):
+    """Like sys.exc_info, but includes the full traceback."""
+    t, v, tb = exc_info
+    full_tb = extend_traceback(tb, current_stack(1))
+    return t, v, full_tb
+
 class RedditLoginFailed(Exception):
     pass
 
@@ -19,6 +52,15 @@ class FileNameTooLong(Exception):
 class InvalidRedditLink(Exception):
     pass
 
+class ProgramModeError(Exception):
+    pass
+
+class SearchModeError(Exception):
+    pass
+
+class RedditorNameError(Exception):
+    pass
+
 class NoMatchingSubmissionFound(Exception):
     pass
 
@@ -38,4 +80,10 @@ class InvalidSortingType(Exception):
     pass
 
 class FileNotFoundError(Exception):
+    pass
+
+class NoSuitablePost(Exception):
+    pass
+
+class ImgurLimitError(Exception):
     pass

src/searcher.py

@@ -1,16 +1,10 @@
 import os
+import sys
 import random
 import socket
 import webbrowser
 
-try:
-    import praw
-except ModuleNotFoundError:
-    print("\nPRAW not found on your computer, installing...\n")
-    from src.tools import install
-    install("praw")
-    import praw
-
+import praw
 from prawcore.exceptions import NotFound, ResponseException, Forbidden
 
 from src.tools import GLOBAL, createLogFile, jsonFile, printToFile
@@ -21,60 +15,62 @@ from src.errors import (NoMatchingSubmissionFound, NoPrawSupport,
 
 print = printToFile
 
-class GetAuth:
-    def __init__(self,redditInstance,port):
-        self.redditInstance = redditInstance
-        self.PORT = int(port)
-
-    def recieve_connection(self):
-        """Wait for and then return a connected socket..
-        Opens a TCP connection on port 8080, and waits for a single client.
-        """
-        server = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-        server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-        server.bind(('localhost', self.PORT))
-        server.listen(1)
-        client = server.accept()[0]
-        server.close()
-        return client
-
-    def send_message(self, message):
-        """Send message to client and close the connection."""
-        self.client.send('HTTP/1.1 200 OK\r\n\r\n{}'.format(message).encode('utf-8'))
-        self.client.close()
-
-    def getRefreshToken(self,*scopes):
-        state = str(random.randint(0, 65000))
-        url = self.redditInstance.auth.url(scopes, state, 'permanent')
-        print("Go to this URL and login to reddit:\n\n",url)
-        webbrowser.open(url,new=2)
-
-        self.client = self.recieve_connection()
-        data = self.client.recv(1024).decode('utf-8')
-        param_tokens = data.split(' ', 2)[1].split('?', 1)[1].split('&')
-        params = {
-            key: value for (key, value) in [token.split('=') \
-            for token in param_tokens]
-        }
-        if state != params['state']:
-            self.send_message(
-                client, 'State mismatch. Expected: {} Received: {}'
-                .format(state, params['state'])
-            )
-            raise RedditLoginFailed
-        elif 'error' in params:
-            self.send_message(client, params['error'])
-            raise RedditLoginFailed
-        
-        refresh_token = self.redditInstance.auth.authorize(params['code'])
-        self.send_message(
-            "<script>" \
-            "alert(\"You can go back to terminal window now.\");" \
-            "</script>"
-        )
-        return (self.redditInstance,refresh_token)
-
 def beginPraw(config,user_agent = str(socket.gethostname())):
+    class GetAuth:
+        def __init__(self,redditInstance,port):
+            self.redditInstance = redditInstance
+            self.PORT = int(port)
+
+        def recieve_connection(self):
+            """Wait for and then return a connected socket..
+            Opens a TCP connection on port 8080, and waits for a single client.
+            """
+            server = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+            server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+            server.bind(('localhost', self.PORT))
+            server.listen(1)
+            client = server.accept()[0]
+            server.close()
+            return client
+
+        def send_message(self, message):
+            """Send message to client and close the connection."""
+            self.client.send(
+                'HTTP/1.1 200 OK\r\n\r\n{}'.format(message).encode('utf-8')
+            )
+            self.client.close()
+
+        def getRefreshToken(self,*scopes):
+            state = str(random.randint(0, 65000))
+            url = self.redditInstance.auth.url(scopes, state, 'permanent')
+            print("Go to this URL and login to reddit:\n\n",url)
+            webbrowser.open(url,new=2)
+
+            self.client = self.recieve_connection()
+            data = self.client.recv(1024).decode('utf-8')
+            param_tokens = data.split(' ', 2)[1].split('?', 1)[1].split('&')
+            params = {
+                key: value for (key, value) in [token.split('=') \
+                for token in param_tokens]
+            }
+            if state != params['state']:
+                self.send_message(
+                    client, 'State mismatch. Expected: {} Received: {}'
+                    .format(state, params['state'])
+                )
+                raise RedditLoginFailed
+            elif 'error' in params:
+                self.send_message(client, params['error'])
+                raise RedditLoginFailed
+            
+            refresh_token = self.redditInstance.auth.authorize(params['code'])
+            self.send_message(
+                "<script>" \
+                "alert(\"You can go back to terminal window now.\");" \
+                "</script>"
+            )
+            return (self.redditInstance,refresh_token)
+
     """Start reddit instance"""
     
     scopes = ['identity','history','read']
@@ -96,7 +92,7 @@ def beginPraw(config,user_agent = str(socket.gethostname())):
             authorizedInstance = GetAuth(reddit,port).getRefreshToken(*scopes)
             reddit = authorizedInstance[0]
             refresh_token = authorizedInstance[1]
-            jsonFile("config.json").add({
+            jsonFile(GLOBAL.configDirectory / "config.json").add({
                 "reddit_refresh_token":refresh_token
             })
     else:
@@ -105,7 +101,7 @@ def beginPraw(config,user_agent = str(socket.gethostname())):
         authorizedInstance = GetAuth(reddit,port).getRefreshToken(*scopes)
         reddit = authorizedInstance[0]
         refresh_token = authorizedInstance[1]
-        jsonFile("config.json").add({
+        jsonFile(GLOBAL.configDirectory / "config.json").add({
             "reddit_refresh_token":refresh_token
         })
     return reddit
@@ -130,7 +126,7 @@ def getPosts(args):
         if args["user"] == "me":
             args["user"] = str(reddit.user.me())
 
-    print("\nGETTING POSTS\n.\n.\n.\n")
+    # print("\nGETTING POSTS\n.\n.\n.\n")
 
     if not "search" in args:
         if args["sort"] == "top" or args["sort"] == "controversial":
@@ -252,8 +248,6 @@ def getPosts(args):
             raise MultiredditNotFound
 
     elif "submitted" in args:
-        # TODO
-        # USE REDDIT.USER.ME() INSTEAD WHEN "ME" PASSED AS A --USER
         print (
             "submitted posts of {user}\nsort: {sort}\n" \
             "time: {time}\nlimit: {limit}\n".format(
@@ -270,8 +264,6 @@ def getPosts(args):
         )
 
     elif "upvoted" in args:
-        # TODO
-        # USE REDDIT.USER.ME() INSTEAD WHEN "ME" PASSED AS A --USER
         print (
             "upvoted posts of {user}\nlimit: {limit}\n".format(
                 user=args["user"],
@@ -306,6 +298,8 @@ def redditSearcher(posts,SINGLE_POST=False):
     gfycatCount = 0
     global imgurCount
     imgurCount = 0
+    global eromeCount
+    eromeCount = 0
     global directCount
     directCount = 0
     global selfCount
@@ -313,6 +307,7 @@ def redditSearcher(posts,SINGLE_POST=False):
 
     allPosts = {}
 
+    print("GETTING POSTS")
     postsFile = createLogFile("POSTS")
 
     if SINGLE_POST:
@@ -333,42 +328,56 @@ def redditSearcher(posts,SINGLE_POST=False):
         if result is not None:
             details = result
             orderCount += 1
-            printSubmission(submission,subCount,orderCount)
+            if GLOBAL.arguments.verbose:
+                printSubmission(submission,subCount,orderCount)
             subList.append(details)
 
         postsFile.add({subCount:[details]})
 
     else:
-        for submission in posts:
-            subCount += 1
+        try:
+            for submission in posts:
+                subCount += 1
 
-            try:
-                details = {'postId':submission.id,
-                           'postTitle':submission.title,
-                           'postSubmitter':str(submission.author),
-                           'postType':None,
-                           'postURL':submission.url,
-                           'postSubreddit':submission.subreddit.display_name}
-            except AttributeError:
-                continue
+                if subCount % 100 == 0 and not GLOBAL.arguments.verbose:
+                    sys.stdout.write("• ")
+                    sys.stdout.flush()
 
-            result = checkIfMatching(submission)
+                if subCount % 1000 == 0:
+                    sys.stdout.write("\n")
+                    sys.stdout.flush()
 
-            if result is not None:
-                details = result
-                orderCount += 1
-                printSubmission(submission,subCount,orderCount)
-                subList.append(details)
+                try:
+                    details = {'postId':submission.id,
+                            'postTitle':submission.title,
+                            'postSubmitter':str(submission.author),
+                            'postType':None,
+                            'postURL':submission.url,
+                            'postSubreddit':submission.subreddit.display_name}
+                except AttributeError:
+                    continue
 
-            allPosts = {**allPosts,**details}
+                result = checkIfMatching(submission)
+
+                if result is not None:
+                    details = result
+                    orderCount += 1
+                    if GLOBAL.arguments.verbose:
+                        printSubmission(submission,subCount,orderCount)
+                    subList.append(details)
+
+                allPosts[subCount] = [details]
+        except KeyboardInterrupt:
+            print("\nKeyboardInterrupt",end="")
         
         postsFile.add(allPosts)
 
     if not len(subList) == 0:    
         print(
-            "\nTotal of {} submissions found!\n"\
-            "{} GFYCATs, {} IMGURs, {} DIRECTs and {} SELF POSTS\n"
-            .format(len(subList),gfycatCount,imgurCount,directCount,selfCount)
+            f"\n\nTotal of {len(subList)} submissions found!\n"\
+            f"{gfycatCount} GFYCATs, {imgurCount} IMGURs, " \
+            f"{eromeCount} EROMEs, {directCount} DIRECTs " \
+            f"and {selfCount} SELF POSTS"
         )
         return subList
     else:
@@ -377,6 +386,7 @@ def redditSearcher(posts,SINGLE_POST=False):
 def checkIfMatching(submission):
     global gfycatCount
     global imgurCount
+    global eromeCount
     global directCount
     global selfCount
 
@@ -390,22 +400,24 @@ def checkIfMatching(submission):
     except AttributeError:
         return None
 
-    if ('gfycat' in submission.domain) or \
-        ('imgur' in submission.domain):
+    if 'gfycat' in submission.domain:
+        details['postType'] = 'gfycat'
+        gfycatCount += 1
+        return details
 
-        if 'gfycat' in submission.domain:
-            details['postType'] = 'gfycat'
-            gfycatCount += 1
-            return details
+    elif 'imgur' in submission.domain:
+        details['postType'] = 'imgur'
+        imgurCount += 1
+        return details
 
-        elif 'imgur' in submission.domain:
-            details['postType'] = 'imgur'
-            
-            imgurCount += 1
-            return details
+    elif 'erome' in submission.domain:
+        details['postType'] = 'erome'
+        eromeCount += 1
+        return details
 
-    elif isDirectLink(submission.url):
+    elif isDirectLink(submission.url) is not False:
         details['postType'] = 'direct'
+        details['postURL'] = isDirectLink(submission.url)
         directCount += 1
         return details
 
@@ -442,7 +454,7 @@ def printSubmission(SUB,validNumber,totalNumber):
 
 def isDirectLink(URL):
     """Check if link is a direct image link.
-    If so, return True,
+    If so, return URL,
     if not, return False
     """
 
@@ -451,10 +463,13 @@ def isDirectLink(URL):
         URL = URL[:-1]
 
     if "i.reddituploads.com" in URL:
-        return True
+        return URL
+
+    elif "v.redd.it" in URL:
+        return URL+"/DASH_600_K"
 
     for extension in imageTypes:
         if extension in URL:
-            return True
+            return URL
     else:
         return False

src/tools.py

@@ -2,20 +2,11 @@ import io
 import json
 import sys
 import time
-
-try:
-    from pip import main as pipmain
-except:
-    from pip._internal import main as pipmain
-
 from os import makedirs, path, remove
 from pathlib import Path
 
 from src.errors import FileNotFoundError
 
-def install(package):
-    pipmain(['install', package])
-
 class GLOBAL:
     """Declare global variables"""
 
@@ -23,6 +14,7 @@ class GLOBAL:
     config = None
     arguments = None
     directory = None
+    configDirectory = Path.home() / "Bulk Downloader for Reddit"
     reddit_client_id = "BSyphDdxYZAgVQ"
     reddit_client_secret = "bfqNJaRh8NMh-9eAr-t4TRz-Blk"
     printVanilla = print
@@ -83,8 +75,10 @@ def createLogFile(TITLE):
     put given arguments inside \"HEADER\" key
     """
 
-    folderDirectory = GLOBAL.directory / str(time.strftime("%d-%m-%Y_%H-%M-%S",
-                                             time.localtime(GLOBAL.RUN_TIME)))
+    folderDirectory = GLOBAL.directory / "LOG_FILES" / \
+                      str(time.strftime(
+                          "%d-%m-%Y_%H-%M-%S",time.localtime(GLOBAL.RUN_TIME)
+                      ))
     logFilename = TITLE.upper()+'.json'
 
     if not path.exists(folderDirectory):
@@ -103,16 +97,17 @@ def printToFile(*args, **kwargs):
     
     TIME = str(time.strftime("%d-%m-%Y_%H-%M-%S",
                              time.localtime(GLOBAL.RUN_TIME)))
-    folderDirectory = GLOBAL.directory / TIME
+    folderDirectory = GLOBAL.directory / "LOG_FILES" / TIME
     print(*args,**kwargs)
 
     if not path.exists(folderDirectory):
         makedirs(folderDirectory)
-        
-    with io.open(
-        folderDirectory / "CONSOLE_LOG.txt","a",encoding="utf-8"
-    ) as FILE:
-        print(*args, file=FILE, **kwargs) 
+    
+    if not "file" in kwargs:
+        with io.open(
+            folderDirectory / "CONSOLE_LOG.txt","a",encoding="utf-8"
+        ) as FILE:
+            print(*args, file=FILE, **kwargs) 
 
 def nameCorrector(string):
     """Swap strange characters from given string 
@@ -138,7 +133,7 @@ def nameCorrector(string):
     if len(string.split('\n')) > 1:
         string = "".join(string.split('\n'))
     
-    BAD_CHARS = ['\\','/',':','*','?','"','<','>','|','.',]
+    BAD_CHARS = ['\\','/',':','*','?','"','<','>','|','.','#']
     
     if any(x in string for x in BAD_CHARS):
         for char in string: