Typo fix

Add submitter to file names

README.md

@@ -6,13 +6,12 @@ This program downloads imgur, gfycat and direct image and video links of saved p
 ## 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 imgur albums, gfycat links, [self posts](#how-do-i-open-self-post-files) and any link to a direct image
+- 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 titles to file's name
+- 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
-- Can run with double-clicking on Windows
 
 ## [Download the latest release](https://github.com/aliparlakci/bulk-downloader-for-reddit/releases/latest)
 
@@ -53,6 +52,11 @@ It should redirect to a page which shows your **imgur_client_id** and **imgur_cl
   them, there.
 
 ## Changes on *master*
+### [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

script.py

@@ -22,7 +22,7 @@ from src.tools import (GLOBAL, createLogFile, jsonFile, nameCorrector,
 
 __author__ = "Ali Parlakci"
 __license__ = "GPL"
-__version__ = "1.4.0"
+__version__ = "1.5.0"
 __maintainer__ = "Ali Parlakci"
 __email__ = "parlakciali@gmail.com"
 
@@ -423,21 +423,36 @@ def postFromLog(fileName):
 
     return posts
 
-def postExists(POST):
+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",".md"]
 
-    for i in range(2):
-        for extension in possibleExtensions:
-            FILE_PATH = PATH / (FILENAME+extension)
-            if FILE_PATH.exists():
-                return True
-        else:
-            FILENAME = POST['postId']
+    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
 
@@ -523,7 +538,7 @@ def download(submissions):
             )
         )
 
-        if postExists(submissions[i]):
+        if isPostExists(submissions[i]):
             print(submissions[i]['postType'].upper())
             print("It already exists")
             duplicates += 1
@@ -546,12 +561,26 @@ def download(submissions):
             sys.exit()
 
         except ImgurLimitError as exception:
-            FAILED_FILE.add({int(i+1):[str(exception),submissions[i]]})
+            FAILED_FILE.add({int(i+1):[
+                "{class_name}: {info}".format(
+                    class_name=exception.__class__.__name__,info=str(exception)
+                ),
+                submissions[i]
+            ]})
             downloadedCount -= 1
 
         except NotADownloadableLinkError as exception:
-            print(exception)
-            FAILED_FILE.add({int(i+1):[str(exception),submissions[i]]})
+            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:
@@ -560,8 +589,17 @@ def download(submissions):
         
         except Exception as exception:
             # raise exception
-            print(exception)
-            FAILED_FILE.add({int(i+1):[str(exception),submissions[i]]})
+            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:
@@ -587,9 +625,6 @@ def main():
         checkConflicts()
     except ProgramModeError as err:
         PromptUser()
-    except Exception as err:
-        print(err)
-        sys.exit()
 
     if not Path(GLOBAL.configDirectory).is_dir():
         os.makedirs(GLOBAL.configDirectory)

src/downloader.py

@@ -87,13 +87,14 @@ class Erome:
             extension = getExtension(IMAGES[0])
 
             title = nameCorrector(post['postTitle'])
-            print(title+"_" +post['postId']+extension)
+            print(post["postSubmitter"]+"_"+title+"_"+post['postId']+extension)
 
-            fileDir = title + "_" + post['postId'] + extension
-            fileDir = directory / fileDir
-
-            tempDir = title + "_" + post['postId'] + '.tmp'
-            tempDir = directory / tempDir
+            fileDir = directory / (
+                POST["postSubmitter"]+"_"+title+"_"+POST['postId']+extension
+            )
+            tempDir = directory / (
+                POST["postSubmitter"]+"_"+title+"_"+POST['postId']+".tmp"
+            )
 
             imageURL = "https:" + IMAGES[0]
 
@@ -106,9 +107,11 @@ class Erome:
 
         else:
             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):
@@ -139,9 +142,16 @@ class Erome:
                     howManyDownloaded -= 1
 
                 except Exception as exception:
-                    raise exception
+                    # raise 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
 
@@ -213,13 +223,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:
@@ -235,9 +254,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):
@@ -290,7 +311,14 @@ 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
 
@@ -355,10 +383,15 @@ class Gfycat:
 
         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:
@@ -404,13 +437,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'])
@@ -425,10 +459,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
@@ -451,7 +486,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/searcher.py

@@ -14,60 +14,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']
@@ -245,8 +247,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(
@@ -263,8 +263,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"],

src/tools.py

@@ -132,7 +132,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: