From 96856e9361946e2ba12c97ebe492b2d56c25125a Mon Sep 17 00:00:00 2001
From: Ethan Dalool <git@voussoir.net>
Date: Sat, 11 Nov 2017 22:49:03 -0800
Subject: [PATCH] Cleanup: More minor dusting, commenting, clarity renaming.

---
 etiquette/constants.py     |  4 +--
 etiquette/objects.py       |  5 ++++
 etiquette/photodb.py       | 61 +++++++++++++++++++++-----------------
 etiquette/searchhelpers.py |  4 ++-
 4 files changed, 43 insertions(+), 31 deletions(-)

diff --git a/etiquette/constants.py b/etiquette/constants.py
index e6f1536..b8893e6 100644
--- a/etiquette/constants.py
+++ b/etiquette/constants.py
@@ -5,8 +5,8 @@ import traceback
 
 try:
     ffmpeg = converter.Converter(
-        ffmpeg_path='C:\\software\\ffmpeg\\bin\\ffmpeg.exe',
-        ffprobe_path='C:\\software\\ffmpeg\\bin\\ffprobe.exe',
+        ffmpeg_path='D:\\software\\ffmpeg\\bin\\ffmpeg.exe',
+        ffprobe_path='D:\\software\\ffmpeg\\bin\\ffprobe.exe',
     )
 except converter.ffmpeg.FFMpegError:
     traceback.print_exc()
diff --git a/etiquette/objects.py b/etiquette/objects.py
index a235df6..ff8e927 100644
--- a/etiquette/objects.py
+++ b/etiquette/objects.py
@@ -249,6 +249,11 @@ class Album(ObjectBase, GroupableMixin):
     @decorators.required_feature('album.edit')
     @decorators.transaction
     def add_associated_directory(self, filepath, *, commit=True):
+        '''
+        Add a directory from which this album will pull files during rescans.
+        These relationships are not unique and multiple albums
+        can associate with the same directory if desired.
+        '''
         filepath = pathclass.Path(filepath)
         if not filepath.is_dir:
             raise ValueError('%s is not a directory' % filepath)
diff --git a/etiquette/photodb.py b/etiquette/photodb.py
index 091d92d..9dbd0cc 100644
--- a/etiquette/photodb.py
+++ b/etiquette/photodb.py
@@ -811,21 +811,20 @@ class PDBPhotoMixin:
                         #print('Failed tag expression')
                         continue
 
-                elif is_must_may_forbid:
-                    pass
-                    # if photo.id not in mmf_results:
-                    #     #print('Failed tag mmf')
-                    #     continue
-                    # success = searchfilter_must_may_forbid(
-                    #     photo_tags=photo_tags,
-                    #     tag_musts=tag_musts,
-                    #     tag_mays=tag_mays,
-                    #     tag_forbids=tag_forbids,
-                    #     frozen_children=frozen_children,
-                    # )
-                    # if not success:
-                    #     #print('Failed tag mmf')
-                    #     continue
+                # elif is_must_may_forbid:
+                #     if photo.id not in mmf_results:
+                #         #print('Failed tag mmf')
+                #         continue
+                #     success = searchfilter_must_may_forbid(
+                #         photo_tags=photo_tags,
+                #         tag_musts=tag_musts,
+                #         tag_mays=tag_mays,
+                #         tag_forbids=tag_forbids,
+                #         frozen_children=frozen_children,
+                #     )
+                #     if not success:
+                #         #print('Failed tag mmf')
+                #         continue
 
             if offset > 0:
                 offset -= 1
@@ -991,21 +990,27 @@ class PDBUserMixin:
         else:
             raise exceptions.NoSuchUser(username or id)
 
-    def get_user_id_or_none(self, user):
+    def get_user_id_or_none(self, user_obj_or_id):
         '''
         For methods that create photos, albums, etc., we sometimes associate
-        them with an author but sometimes not. This method hides validation
-        that those methods would otherwise have to duplicate.
+        them with an author but sometimes not. The callers of those methods
+        might be trying to use a User object, or a user's ID, or maybe they
+        left it None.
+        This method hides validation that those methods would otherwise
+        have to duplicate.
         '''
-        if isinstance(user, objects.User):
-            if user.photodb != self:
-                raise ValueError('That user does not belong to this photodb')
-            author_id = user.id
-        elif user is not None:
-            # Confirm that this string is an ID and not junk.
-            author_id = self.get_user(id=user).id
-        else:
+        if user_obj_or_id is None:
             author_id = None
+
+        elif isinstance(user_obj_or_id, objects.User):
+            if user_obj_or_id.photodb != self:
+                raise ValueError('That user does not belong to this photodb')
+            author_id = user_obj_or_id.id
+
+        else:
+            # Confirm that this string is a valid ID and not junk.
+            author_id = self.get_user(id=user_obj_or_id).id
+
         return author_id
 
     @decorators.required_feature('user.login')
@@ -1017,11 +1022,11 @@ class PDBUserMixin:
         if fetch is None:
             raise exceptions.WrongLogin()
 
-        stored_password = fetch[constants.SQL_USER['password']]
-
         if not isinstance(password, bytes):
             password = password.encode('utf-8')
 
+        stored_password = fetch[constants.SQL_USER['password']]
+
         success = bcrypt.checkpw(password, stored_password)
         if not success:
             raise exceptions.WrongLogin()
diff --git a/etiquette/searchhelpers.py b/etiquette/searchhelpers.py
index 4509582..b63d9a1 100644
--- a/etiquette/searchhelpers.py
+++ b/etiquette/searchhelpers.py
@@ -27,7 +27,9 @@ def build_query(
 
     if mmf_results:
         # "id IN/NOT IN (1, 2, 3)"
-        wheres.add('id %s %s' % (mmf_results['operator'], helpers.sql_listify(mmf_results['photoids'])))
+        operator = mmf_results['operator']
+        photo_ids = helpers.sql_listify(mmf_results['photo_ids'])
+        wheres.add('id %s %s' % (operator, photo_ids))
 
     if orderby:
         orderby = [o.split('-') for o in orderby]