import bcrypt import collections import converter import datetime import functools import logging import mimetypes import os import PIL.Image import random import re import sqlite3 import string import sys import time import traceback import warnings import constants import decorators import exceptions import helpers # pip install # https://raw.githubusercontent.com/voussoir/else/master/_voussoirkit/voussoirkit.zip from voussoirkit import bytestring from voussoirkit import pathclass from voussoirkit import spinal try: ffmpeg = converter.Converter( ffmpeg_path='C:\\software\\ffmpeg\\bin\\ffmpeg.exe', ffprobe_path='C:\\software\\ffmpeg\\bin\\ffprobe.exe', ) except converter.ffmpeg.FFMpegError: traceback.print_exc() ffmpeg = None logging.basicConfig(level=logging.DEBUG) log = logging.getLogger(__name__) logging.getLogger('PIL.PngImagePlugin').setLevel(logging.WARNING) SQL_LASTID_COLUMNS = [ 'table', 'last_id', ] SQL_ALBUM_COLUMNS = [ 'id', 'title', 'description', 'associated_directory', ] SQL_PHOTO_COLUMNS = [ 'id', 'filepath', 'override_filename', 'extension', 'width', 'height', 'ratio', 'area', 'duration', 'bytes', 'created', 'thumbnail', 'tagged_at', ] SQL_TAG_COLUMNS = [ 'id', 'name', ] SQL_SYN_COLUMNS = [ 'name', 'master', ] SQL_ALBUMPHOTO_COLUMNS = [ 'albumid', 'photoid', ] SQL_PHOTOTAG_COLUMNS = [ 'photoid', 'tagid', ] SQL_TAGGROUP_COLUMNS = [ 'parentid', 'memberid', ] SQL_USER_COLUMNS = [ 'id', 'username', 'password', 'created', ] _sql_dictify = lambda columns: {key:index for (index, key) in enumerate(columns)} SQL_ALBUM = _sql_dictify(SQL_ALBUM_COLUMNS) SQL_ALBUMPHOTO = _sql_dictify(SQL_ALBUMPHOTO_COLUMNS) SQL_LASTID = _sql_dictify(SQL_LASTID_COLUMNS) SQL_PHOTO = _sql_dictify(SQL_PHOTO_COLUMNS) SQL_PHOTOTAG = _sql_dictify(SQL_PHOTOTAG_COLUMNS) SQL_SYN = _sql_dictify(SQL_SYN_COLUMNS) SQL_TAG = _sql_dictify(SQL_TAG_COLUMNS) SQL_TAGGROUP = _sql_dictify(SQL_TAGGROUP_COLUMNS) SQL_USER = _sql_dictify(SQL_USER_COLUMNS) # Note: Setting user_version pragma in init sequence is safe because it only # happens after the out-of-date check occurs, so no chance of accidentally # overwriting it. DATABASE_VERSION = 3 DB_INIT = ''' PRAGMA count_changes = OFF; PRAGMA cache_size = 10000; PRAGMA user_version = {user_version}; CREATE TABLE IF NOT EXISTS albums( id TEXT, title TEXT, description TEXT, associated_directory TEXT COLLATE NOCASE ); CREATE TABLE IF NOT EXISTS photos( id TEXT, filepath TEXT COLLATE NOCASE, override_filename TEXT COLLATE NOCASE, extension TEXT, width INT, height INT, ratio REAL, area INT, duration INT, bytes INT, created INT, thumbnail TEXT, tagged_at INT ); CREATE TABLE IF NOT EXISTS tags( id TEXT, name TEXT ); CREATE TABLE IF NOT EXISTS album_photo_rel( albumid TEXT, photoid TEXT ); CREATE TABLE IF NOT EXISTS photo_tag_rel( photoid TEXT, tagid TEXT ); CREATE TABLE IF NOT EXISTS tag_group_rel( parentid TEXT, memberid TEXT ); CREATE TABLE IF NOT EXISTS tag_synonyms( name TEXT, mastername TEXT ); CREATE TABLE IF NOT EXISTS id_numbers( tab TEXT, last_id TEXT ); CREATE TABLE IF NOT EXISTS users( id TEXT, username TEXT COLLATE NOCASE, password BLOB, created INT ); -- Album CREATE INDEX IF NOT EXISTS index_album_id on albums(id); CREATE INDEX IF NOT EXISTS index_albumrel_albumid on album_photo_rel(albumid); CREATE INDEX IF NOT EXISTS index_albumrel_photoid on album_photo_rel(photoid); -- Photo CREATE INDEX IF NOT EXISTS index_photo_id on photos(id); CREATE INDEX IF NOT EXISTS index_photo_path on photos(filepath COLLATE NOCASE); CREATE INDEX IF NOT EXISTS index_photo_fakepath on photos(override_filename COLLATE NOCASE); CREATE INDEX IF NOT EXISTS index_photo_created on photos(created); CREATE INDEX IF NOT EXISTS index_photo_extension on photos(extension); -- Tag CREATE INDEX IF NOT EXISTS index_tag_id on tags(id); CREATE INDEX IF NOT EXISTS index_tag_name on tags(name); -- Photo-tag relation CREATE INDEX IF NOT EXISTS index_tagrel_photoid on photo_tag_rel(photoid); CREATE INDEX IF NOT EXISTS index_tagrel_tagid on photo_tag_rel(tagid); -- Tag-synonym relation CREATE INDEX IF NOT EXISTS index_tagsyn_name on tag_synonyms(name); -- Tag-group relation CREATE INDEX IF NOT EXISTS index_grouprel_parentid on tag_group_rel(parentid); CREATE INDEX IF NOT EXISTS index_grouprel_memberid on tag_group_rel(memberid); -- User CREATE INDEX IF NOT EXISTS index_user_id on users(id); CREATE INDEX IF NOT EXISTS index_user_username on users(username COLLATE NOCASE); '''.format(user_version=DATABASE_VERSION) def _helper_filenamefilter(subject, terms): basename = subject.lower() return all(term in basename for term in terms) def binding_filler(column_names, values, require_all=True): ''' Manually aligning question marks and bindings is annoying. Given the table's column names and a dictionary of {column: value}, return the question marks and the list of bindings in the right order. ''' values = values.copy() for column in column_names: if column in values: continue if require_all: raise ValueError('Missing column "%s"' % column) else: values.setdefault(column, None) qmarks = '?' * len(column_names) qmarks = ', '.join(qmarks) bindings = [values[column] for column in column_names] return (qmarks, bindings) def getnow(timestamp=True): ''' Return the current UTC timestamp or datetime object. ''' now = datetime.datetime.now(datetime.timezone.utc) if timestamp: return now.timestamp() return now def normalize_filepath(filepath): ''' Remove some bad characters. ''' filepath = filepath.replace('/', os.sep) filepath = filepath.replace('\\', os.sep) filepath = filepath.replace('<', '') filepath = filepath.replace('>', '') return filepath def normalize_tagname(tagname): ''' Tag names can only consist of VALID_TAG_CHARS. The given tagname is lowercased, gets its spaces and hyphens replaced by underscores, and is stripped of any not-whitelisted characters. ''' tagname = tagname.lower() tagname = tagname.replace('-', '_') tagname = tagname.replace(' ', '_') tagname = (c for c in tagname if c in constants.VALID_TAG_CHARS) tagname = ''.join(tagname) if len(tagname) < constants.MIN_TAG_NAME_LENGTH: raise exceptions.TagTooShort(tagname) if len(tagname) > constants.MAX_TAG_NAME_LENGTH: raise exceptions.TagTooLong(tagname) return tagname def operate(operand_stack, operator_stack): #print('before:', operand_stack, operator_stack) operator = operator_stack.pop() if operator == 'NOT': operand = operand_stack.pop() value = operand ^ 1 else: right = operand_stack.pop() left = operand_stack.pop() if operator == 'OR': value = left | right elif operator == 'AND': value = left & right else: raise ValueError('werwer') operand_stack.append(value) #print('after:', operand_stack, operator_stack) def raise_no_such_thing(exception_class, thing_id=None, thing_name=None, comment=''): if thing_id is not None: message = 'ID: %s. %s' % (thing_id, comment) elif thing_name is not None: message = 'Name: %s. %s' % (thing_name, comment) else: message = '' raise exception_class(message) def searchfilter_expression(photo_tags, expression, frozen_children, warn_bad_tags): photo_tags = set(tag.name for tag in photo_tags) operator_stack = collections.deque() operand_stack = collections.deque() expression = expression.replace('-', ' ') expression = expression.strip() if not expression: return False expression = expression.replace('(', ' ( ') expression = expression.replace(')', ' ) ') while ' ' in expression: expression = expression.replace(' ', ' ') tokens = [token for token in expression.split(' ') if token] has_operand = False can_shortcircuit = False for token in tokens: #print(token, end=' ', flush=True) if can_shortcircuit and token != ')': continue if token not in constants.EXPRESSION_OPERATORS: try: token = normalize_tagname(token) value = any(option in photo_tags for option in frozen_children[token]) except KeyError: if warn_bad_tags: warnings.warn(constants.WARNING_NO_SUCH_TAG.format(tag=token)) else: raise exceptions.NoSuchTag(token) return False operand_stack.append(value) if has_operand: operate(operand_stack, operator_stack) has_operand = True continue if token == '(': has_operand = False if token == ')': if not can_shortcircuit: while operator_stack[-1] != '(': operate(operand_stack, operator_stack) operator_stack.pop() has_operand = True continue can_shortcircuit = ( has_operand and ( (operand_stack[-1] == 0 and token == 'AND') or (operand_stack[-1] == 1 and token == 'OR') ) ) if can_shortcircuit: if operator_stack and operator_stack[-1] == '(': operator_stack.pop() continue operator_stack.append(token) #time.sleep(.3) #print() while len(operand_stack) > 1 or len(operator_stack) > 0: operate(operand_stack, operator_stack) #print(operand_stack) return operand_stack.pop() def searchfilter_must_may_forbid(photo_tags, tag_musts, tag_mays, tag_forbids, frozen_children): if tag_musts and not all(any(option in photo_tags for option in frozen_children[must]) for must in tag_musts): #print('Failed musts') return False if tag_mays and not any(option in photo_tags for may in tag_mays for option in frozen_children[may]): #print('Failed mays') return False if tag_forbids and any(option in photo_tags for forbid in tag_forbids for option in frozen_children[forbid]): #print('Failed forbids') return False return True def select(sql, query, bindings=None): bindings = bindings or [] cursor = sql.cursor() cursor.execute(query, bindings) while True: fetch = cursor.fetchone() if fetch is None: break yield fetch def tag_export_easybake(tags, depth=0): lines = [] for tag in tags: if not hasattr(tag, 'string'): tag.string = tag.name children = tag.children() synonyms = tag.synonyms() lines.append(tag.string) for synonym in synonyms: synonym = tag.string + '+' + synonym lines.append(synonym) for child in children: child.string = tag.string + '.' + child.name child_bake = tag_export_easybake(children, depth=depth+1) if child_bake != '': lines.append(child_bake) lines = '\n'.join(lines) return lines def tag_export_json(tags): def fill(tag): children = {child.name:fill(child) for child in tag.children()} return children result = {} for tag in tags: result[tag.name] = fill(tag) return result def tag_export_qualname_map(tags): lines = tag_export_easybake(tags) lines = lines.split('\n') lines = [line for line in lines if line] qualname_map = {} for line in lines: key = line.split('.')[-1].split('+')[-1] value = line.split('+')[0] qualname_map[key] = value return qualname_map def tag_export_stdout(tags, depth=0): for tag in tags: children = tag.children() synonyms = tag.synonyms() pad = ' ' * depth synpad = ' ' * (depth + 1) print(pad + str(tag)) for synonym in synonyms: print(synpad + synonym) tag_export_stdout(children, depth=depth+1) if tag.parent() is None: print() @decorators.time_me def tag_export_totally_flat(tags): result = {} for tag in tags: for child in tag.walk_children(): children = list(child.walk_children()) result[child] = children for synonym in child.synonyms(): result[synonym] = children return result #################################################################################################### #################################################################################################### class PDBAlbumMixin: def get_album(self, id): return self.get_thing_by_id('album', id) def get_album_by_path(self, filepath): ''' Return the album with the `associated_directory` of this value, NOT case-sensitive. ''' filepath = os.path.abspath(filepath) self.cur.execute('SELECT * FROM albums WHERE associated_directory == ?', [filepath]) fetch = self.cur.fetchone() if fetch is None: raise exceptions.NoSuchAlbum(filepath) return self.get_album(fetch[SQL_ALBUM['id']]) def get_albums(self): yield from self.get_things(thing_type='album') def new_album( self, title=None, description=None, *, associated_directory=None, commit=True, photos=None ): ''' Create a new album. Photos can be added now or later. ''' # Albums share the tag table's ID counter albumid = self.generate_id('tags') title = title or '' description = description or '' if associated_directory is not None: associated_directory = os.path.abspath(associated_directory) if not isinstance(title, str): raise TypeError('Title must be string, not %s' % type(title)) if not isinstance(description, str): raise TypeError('Description must be string, not %s' % type(description)) data = {} data['id'] = albumid data['title'] = title data['description'] = description data['associated_directory'] = associated_directory (qmarks, bindings) = binding_filler(SQL_ALBUM_COLUMNS, data) query = 'INSERT INTO albums VALUES(%s)' % qmarks self.cur.execute(query, bindings) album = Album(self, data) if photos: for photo in photos: photo = self.get_photo(photo) album.add_photo(photo, commit=False) if commit: log.debug('Committing - new Album') self.commit() return album class PDBPhotoMixin: def get_photo(self, photoid): return self.get_thing_by_id('photo', photoid) def get_photo_by_path(self, filepath): filepath = os.path.abspath(filepath) self.cur.execute('SELECT * FROM photos WHERE filepath == ?', [filepath]) fetch = self.cur.fetchone() if fetch is None: raise_no_such_thing(exceptions.NoSuchPhoto, thing_name=filepath) photo = Photo(self, fetch) return photo def get_photos_by_recent(self, count=None): ''' Yield photo objects in order of creation time. ''' if count is not None and count <= 0: return # We're going to use a second cursor because the first one may # get used for something else, deactivating this query. temp_cur = self.sql.cursor() temp_cur.execute('SELECT * FROM photos ORDER BY created DESC') while True: fetch = temp_cur.fetchone() if fetch is None: break photo = Photo(self, fetch) yield photo if count is None: continue count -= 1 if count <= 0: break def purge_deleted_files(self): ''' Remove Photo entries if their corresponding file is no longer found. ''' photos = self.get_photos_by_recent() for photo in photos: if os.path.exists(photo.real_filepath): continue photo.delete() def purge_empty_albums(self): albums = self.get_albums() for album in albums: if album.children() or album.photos(): continue album.delete() def new_photo( self, filename, *, allow_duplicates=False, commit=True, do_metadata=True, do_thumbnail=True, tags=None ): ''' Given a filepath, determine its attributes and create a new Photo object in the database. Tags may be applied now or later. If `allow_duplicates` is False, we will first check the database for any files with the same path and raise exceptions.PhotoExists if found. Returns the Photo object. ''' filename = os.path.abspath(filename) assert os.path.isfile(filename) if not allow_duplicates: try: existing = self.get_photo_by_path(filename) except exceptions.NoSuchPhoto: pass else: exc = exceptions.PhotoExists(filename, existing) exc.photo = existing raise exc extension = os.path.splitext(filename)[1] extension = extension.replace('.', '') extension = normalize_tagname(extension) created = int(getnow()) photoid = self.generate_id('photos') data = {} data['id'] = photoid data['filepath'] = filename data['override_filename'] = None data['extension'] = extension data['created'] = created data['tagged_at'] = None # These will be filled in during the metadata stage. data['bytes'] = None data['width'] = None data['height'] = None data['area'] = None data['ratio'] = None data['duration'] = None data['thumbnail'] = None (qmarks, bindings) = binding_filler(SQL_PHOTO_COLUMNS, data) query = 'INSERT INTO photos VALUES(%s)' % qmarks self.cur.execute(query, bindings) photo = Photo(self, data) if do_metadata: photo.reload_metadata(commit=False) if do_thumbnail: photo.generate_thumbnail(commit=False) tags = tags or [] tags = [self.get_tag(tag) for tag in tags] for tag in tags: photo.add_tag(tag, commit=False) if commit: log.debug('Commiting - new_photo') self.commit() return photo def search( self, *, area=None, width=None, height=None, ratio=None, bytes=None, duration=None, created=None, extension=None, extension_not=None, filename=None, has_tags=None, mimetype=None, tag_musts=None, tag_mays=None, tag_forbids=None, tag_expression=None, warn_bad_tags=False, limit=None, offset=None, orderby=None ): ''' PHOTO PROPERTISE area, width, height, ratio, bytes, duration: A hyphen_range string representing min and max. Or just a number for lower bound. TAGS AND FILTERS created: A hyphen_range string respresenting min and max. Or just a number for lower bound. extension: A string or list of strings of acceptable file extensions. extension_not: A string or list of strings of unacceptable file extensions. filename: A string or list of strings which will be split into words. The file's basename must include every word, NOT case-sensitive. has_tags: If True, require that the Photo has >=1 tag. If False, require that the Photo has no tags. If None, not considered. mimetype: A string or list of strings of acceptable mimetypes. 'image', 'video', ... tag_musts: A list of tag names or Tag objects. Photos MUST have ALL tags in this list. tag_mays: A list of tag names or Tag objects. Photos MUST have AT LEAST ONE tag in this list. tag_forbids: A list of tag names or Tag objects. Photos MUST NOT have ANY tag in the list. tag_expression: A string like 'family AND (animals OR vacation)' to filter by. Can NOT be used with the must, may, forbid style search. QUERY OPTIONS warn_bad_tags: If a tag is not found, issue a warning but continue the search. Otherwise, a exceptions.NoSuchTag exception would be raised. limit: The maximum number of *successful* results to yield. offset: How many *successful* results to skip before we start yielding. orderby: A list of strings like ['ratio DESC', 'created ASC'] to sort and subsort the results. Descending is assumed if not provided. ''' start_time = time.time() maximums = {} minimums = {} helpers._minmax('area', area, minimums, maximums) helpers._minmax('created', created, minimums, maximums) helpers._minmax('width', width, minimums, maximums) helpers._minmax('height', height, minimums, maximums) helpers._minmax('ratio', ratio, minimums, maximums) helpers._minmax('bytes', bytes, minimums, maximums) helpers._minmax('duration', duration, minimums, maximums) orderby = orderby or [] extension = helpers._normalize_extensions(extension) extension_not = helpers._normalize_extensions(extension_not) mimetype = helpers._normalize_extensions(mimetype) if filename is not None: if not isinstance(filename, str): filename = ' '.join(filename) filename = set(term.lower() for term in filename.strip().split(' ')) if (tag_musts or tag_mays or tag_forbids) and tag_expression: raise exceptions.NotExclusive('Expression filter cannot be used with musts, mays, forbids') tag_musts = helpers._setify_tags(photodb=self, tags=tag_musts, warn_bad_tags=warn_bad_tags) tag_mays = helpers._setify_tags(photodb=self, tags=tag_mays, warn_bad_tags=warn_bad_tags) tag_forbids = helpers._setify_tags(photodb=self, tags=tag_forbids, warn_bad_tags=warn_bad_tags) query = 'SELECT * FROM photos' orderby = [helpers._orderby(o) for o in orderby] orderby = [o for o in orderby if o] if orderby: whereable_columns = [o[0] for o in orderby if o[0] != 'RANDOM()'] whereable_columns = [column + ' IS NOT NULL' for column in whereable_columns] if whereable_columns: query += ' WHERE ' query += ' AND '.join(whereable_columns) orderby = [' '.join(o) for o in orderby] orderby = ', '.join(orderby) query += ' ORDER BY %s' % orderby else: query += ' ORDER BY created DESC' print(query) generator = select(self.sql, query) # To lighten the amount of database reading here, `frozen_children` is a dict where # EVERY tag in the db is a key, and the value is a list of ALL ITS NESTED CHILDREN. # This representation is memory inefficient, but it is faster than repeated # database lookups is_must_may_forbid = bool(tag_musts or tag_mays or tag_forbids) is_tagsearch = is_must_may_forbid or tag_expression if is_tagsearch: if self._cached_frozen_children: frozen_children = self._cached_frozen_children else: frozen_children = self.export_tags(tag_export_totally_flat) self._cached_frozen_children = frozen_children photos_received = 0 for fetch in generator: photo = Photo(self, fetch) if extension and photo.extension not in extension: #print('Failed extension') continue if extension_not and photo.extension in extension_not: #print('Failed extension_not') continue if mimetype and photo.mimetype() not in mimetype: #print('Failed mimetype') continue if filename and not _helper_filenamefilter(subject=photo.basename, terms=filename): #print('Failed filename') continue if any(not fetch[SQL_PHOTO[key]] or fetch[SQL_PHOTO[key]] > value for (key, value) in maximums.items()): #print('Failed maximums') continue if any(not fetch[SQL_PHOTO[key]] or fetch[SQL_PHOTO[key]] < value for (key, value) in minimums.items()): #print('Failed minimums') continue if (has_tags is not None) or is_tagsearch: photo_tags = photo.tags() if has_tags is False and len(photo_tags) > 0: continue if has_tags is True and len(photo_tags) == 0: continue photo_tags = set(photo_tags) if tag_expression: if not searchfilter_expression(photo_tags, tag_expression, frozen_children, warn_bad_tags): continue elif is_must_may_forbid: if not searchfilter_must_may_forbid(photo_tags, tag_musts, tag_mays, tag_forbids, frozen_children): continue if offset is not None and offset > 0: offset -= 1 continue if limit is not None and photos_received >= limit: break photos_received += 1 yield photo end_time = time.time() print(end_time - start_time) class PDBTagMixin: def export_tags(self, exporter=tag_export_stdout, specific_tag=None): ''' Send the top-level tags to function `exporter`. Strings 'start' and 'stop' are sent before and after the tags are sent. Recursion is to be handled by the exporter. ''' if specific_tag is None: items = list(self.get_tags()) items = [item for item in items if item.parent() is None] items.sort(key=lambda x: x.name) else: items = [self.get_tag(specific_tag)] return exporter(items) def get_tag(self, name=None, id=None): ''' Redirect to get_tag_by_id or get_tag_by_name after xor-checking the parameters. ''' if not helpers.is_xor(id, name): raise exceptions.NotExclusive('One and only one of `id`, `name` must be passed.') if id is not None: return self.get_tag_by_id(id) elif name is not None: return self.get_tag_by_name(name) else: raise_no_such_thing(exceptions.NoSuchTag, thing_id=id, thing_name=name) def get_tag_by_id(self, id): return self.get_thing_by_id('tag', thing_id=id) def get_tag_by_name(self, tagname): if isinstance(tagname, Tag): tagname = tagname.name tagname = tagname.split('.')[-1].split('+')[0] tagname = normalize_tagname(tagname) while True: # Return if it's a toplevel, or resolve the synonym and try that. self.cur.execute('SELECT * FROM tags WHERE name == ?', [tagname]) fetch = self.cur.fetchone() if fetch is not None: return Tag(self, fetch) self.cur.execute('SELECT * FROM tag_synonyms WHERE name == ?', [tagname]) fetch = self.cur.fetchone() if fetch is None: # was not a top tag or synonym raise_no_such_thing(exceptions.NoSuchTag, thing_name=tagname) tagname = fetch[SQL_SYN['master']] def get_tags(self): yield from self.get_things(thing_type='tag') def new_tag(self, tagname, *, commit=True): ''' Register a new tag and return the Tag object. ''' tagname = normalize_tagname(tagname) try: self.get_tag_by_name(tagname) except exceptions.NoSuchTag: pass else: raise exceptions.TagExists(tagname) tagid = self.generate_id('tags') self._cached_frozen_children = None self.cur.execute('INSERT INTO tags VALUES(?, ?)', [tagid, tagname]) if commit: log.debug('Commiting - new_tag') self.commit() tag = Tag(self, [tagid, tagname]) return tag class PDBUserMixin: def generate_user_id(self): ''' User IDs are randomized instead of integers like the other objects, so they get their own method. ''' possible = string.digits + string.ascii_uppercase for retry in range(20): user_id = [random.choice(possible) for x in range(self.id_length)] user_id = ''.join(user_id) self.cur.execute('SELECT * FROM users WHERE id == ?', [user_id]) if self.cur.fetchone() is None: break else: raise Exception('Failed to create user id after 20 tries.') return user_id def get_user(self, username=None, id=None): if not helpers.is_xor(id, username): raise exceptions.NotExclusive('One and only one of `id`, `username` must be passed.') if username is not None: self.cur.execute('SELECT * FROM users WHERE username == ?', [username]) else: self.cur.execute('SELECT * FROM users WHERE id == ?', [id]) fetch = self.cur.fetchone() if fetch is not None: return User(self, fetch) else: raise exceptions.NoSuchUser(username) def login(self, user_id, password): self.cur.execute('SELECT * FROM users WHERE id == ?', [user_id]) fetch = self.cur.fetchone() if fetch is None: raise exceptions.WrongLogin() stored_password = fetch[SQL_USER['password']] if not isinstance(password, bytes): password = password.encode('utf-8') success = bcrypt.checkpw(password, stored_password) if not success: raise exceptions.WrongLogin() return User(self, fetch) def register_user(self, username, password, commit=True): if len(username) < constants.MIN_USERNAME_LENGTH: raise exceptions.UsernameTooShort(username) if len(username) > constants.MAX_USERNAME_LENGTH: raise exceptions.UsernameTooLong(username) badchars = [c for c in username if c not in constants.VALID_USERNAME_CHARS] if badchars: raise exceptions.InvalidUsernameChars(badchars) if not isinstance(password, bytes): password = password.encode('utf-8') if len(password) < constants.MIN_PASSWORD_LENGTH: raise exceptions.PasswordTooShort self.cur.execute('SELECT * FROM users WHERE username == ?', [username]) if self.cur.fetchone() is not None: raise exceptions.UserExists(username) user_id = self.generate_user_id() hashed_password = bcrypt.hashpw(password, bcrypt.gensalt()) created = int(getnow()) data = {} data['id'] = user_id data['username'] = username data['password'] = hashed_password data['created'] = created (qmarks, bindings) = binding_filler(SQL_USER_COLUMNS, data) query = 'INSERT INTO users VALUES(%s)' % qmarks self.cur.execute(query, bindings) if commit: log.debug('Committing - register user') self.commit() return User(self, data) class PhotoDB(PDBAlbumMixin, PDBPhotoMixin, PDBTagMixin, PDBUserMixin): ''' This class represents an SQLite3 database containing the following tables: albums: Rows represent the inclusion of a photo in an album photos: Rows represent image files on the local disk. Entries contain a unique ID, the image's filepath, and metadata like dimensions and filesize. tags: Rows represent labels, which can be applied to an arbitrary number of photos. Photos may be selected by which tags they contain. Entries contain a unique ID and a name. photo_tag_rel: Rows represent a Photo's ownership of a particular Tag. tag_synonyms: Rows represent relationships between two tag names, so that they both resolve to the same Tag object when selected. Entries contain the subordinate name and master name. The master name MUST also exist in the `tags` table. If a new synonym is created referring to another synoym, the master name will be resolved and used instead, so a synonym never points to another synonym. Tag objects will ALWAYS represent the master tag. Note that the entries in this table do not contain ID numbers. The rationale here is that "coco" is a synonym for "chocolate" regardless of the "chocolate" tag's ID, and that if a tag is renamed, its synonyms do not necessarily follow. The `rename` method of Tag objects includes a parameter `apply_to_synonyms` if you do want them to follow. ''' def __init__( self, data_directory=None, *, id_length=None ): if data_directory is None: data_directory = constants.DEFAULT_DATADIR if id_length is None: id_length = constants.DEFAULT_ID_LENGTH data_directory = normalize_filepath(data_directory) self.data_directory = os.path.abspath(data_directory) os.makedirs(self.data_directory, exist_ok=True) self.database_abspath = os.path.join(data_directory, 'phototagger.db') existing_database = os.path.exists(self.database_abspath) self.sql = sqlite3.connect(self.database_abspath) self.cur = self.sql.cursor() if existing_database: self.cur.execute('PRAGMA user_version') existing_version = self.cur.fetchone()[0] if existing_version != DATABASE_VERSION: message = constants.ERROR_DATABASE_OUTOFDATE message = message.format(current=existing_version, new=DATABASE_VERSION) raise SystemExit(message) statements = DB_INIT.split(';') for statement in statements: self.cur.execute(statement) self.thumbnail_directory = os.path.join(self.data_directory, 'site_thumbnails') self.thumbnail_directory = os.path.abspath(self.thumbnail_directory) os.makedirs(self.thumbnail_directory, exist_ok=True) self.id_length = id_length self.on_commit_queue = [] self._cached_frozen_children = None def __repr__(self): return 'PhotoDB(data_directory={datadir})'.format(datadir=repr(self.data_directory)) def _uncache(self): self._cached_frozen_children = None def commit(self): while self.on_commit_queue: task = self.on_commit_queue.pop() print(task) args = task.get('args', []) kwargs = task.get('kwargs', {}) task['action'](*args, **kwargs) self.sql.commit() def digest_directory( self, directory, *, exclude_directories=None, exclude_filenames=None, commit=True ): ''' Create an album, and add the directory's contents to it recursively. If a Photo object already exists for a file, it will be added to the correct album. ''' if not os.path.isdir(directory): raise ValueError('Not a directory: %s' % directory) if exclude_directories is None: exclude_directories = constants.DEFAULT_DIGEST_EXCLUDE_DIRS if exclude_filenames is None: exclude_filenames = constants.DEFAULT_DIGEST_EXCLUDE_FILES directory = spinal.str_to_fp(directory) directory.correct_case() generator = spinal.walk_generator( directory, exclude_directories=exclude_directories, exclude_filenames=exclude_filenames, yield_style='nested', ) try: album = self.get_album_by_path(directory.absolute_path) except exceptions.NoSuchAlbum: album = self.new_album( associated_directory=directory.absolute_path, commit=False, title=directory.basename, ) albums = {directory.absolute_path: album} for (current_location, directories, files) in generator: current_album = albums.get(current_location.absolute_path, None) if current_album is None: try: current_album = self.get_album_by_path(current_location.absolute_path) except exceptions.NoSuchAlbum: current_album = self.new_album( associated_directory=current_location.absolute_path, commit=False, title=current_location.basename, ) print('Created %s' % current_album.title) albums[current_location.absolute_path] = current_album parent = albums[current_location.parent.absolute_path] try: parent.add(current_album, commit=False) except exceptions.GroupExists: pass #print('Added to %s' % parent.title) for filepath in files: try: photo = self.new_photo(filepath.absolute_path, commit=False) except exceptions.PhotoExists as e: photo = e.photo current_album.add_photo(photo, commit=False) if commit: log.debug('Commiting - digest') self.commit() return album def digest_new_files( self, directory, exclude_directories=None, exclude_filenames=None, recurse=False, commit=True ): ''' Walk the directory and add new files as Photos. Does NOT create or modify any albums like `digest_directory` does. ''' if not os.path.isdir(directory): raise ValueError('Not a directory: %s' % directory) if exclude_directories is None: exclude_directories = constants.DEFAULT_DIGEST_EXCLUDE_DIRS if exclude_filenames is None: exclude_filenames = constants.DEFAULT_DIGEST_EXCLUDE_FILES directory = spinal.str_to_fp(directory) generator = spinal.walk_generator( directory, exclude_directories=exclude_directories, exclude_filenames=exclude_filenames, recurse=recurse, yield_style='flat', ) for filepath in generator: filepath = filepath.absolute_path try: photo = self.get_photo_by_path(filepath) except exceptions.NoSuchPhoto: pass else: continue photo = self.new_photo(filepath, commit=False) if commit: log.debug('Committing - digest_new_files') self.commit() def easybake(self, string): ''' Easily create tags, groups, and synonyms with a string like "group1.group2.tag+synonym" "family.parents.dad+father" etc ''' output_notes = [] def create_or_get(name): print('cog', name) try: item = self.get_tag(name) note = ('existing_tag', item.qualified_name()) except exceptions.NoSuchTag: item = self.new_tag(name) note = ('new_tag', item.qualified_name()) output_notes.append(note) return item string = string.strip() string = string.strip('.+=') if string == '': return if '=' in string and '+' in string: raise ValueError('Cannot rename and assign snynonym at once') rename_parts = string.split('=') if len(rename_parts) == 2: (string, rename_to) = rename_parts elif len(rename_parts) == 1: string = rename_parts[0] rename_to = None else: raise ValueError('Too many equals signs') create_parts = string.split('+') if len(create_parts) == 2: (tag, synonym) = create_parts elif len(create_parts) == 1: tag = create_parts[0] synonym = None else: raise ValueError('Too many plus signs') if not tag: return None if rename_to: tag = self.get_tag(tag) note = ('rename', '%s=%s' % (tag.name, rename_to)) tag.rename(rename_to) output_notes.append(note) else: tag_parts = tag.split('.') tags = [create_or_get(t) for t in tag_parts] for (higher, lower) in zip(tags, tags[1:]): try: lower.join_group(higher) note = ('join_group', '%s.%s' % (higher.name, lower.name)) output_notes.append(note) except exceptions.GroupExists: pass tag = tags[-1] if synonym: try: tag.add_synonym(synonym) note = ('new_synonym', '%s+%s' % (tag.name, synonym)) output_notes.append(note) print('New syn %s' % synonym) except exceptions.TagExists: pass return output_notes def generate_id(self, table): ''' Create a new ID number that is unique to the given table. Note that while this method may INSERT / UPDATE, it does not commit. We'll wait for that to happen in whoever is calling us, so we know the ID is actually used. ''' table = table.lower() if table not in ['photos', 'tags', 'groups']: raise ValueError('Invalid table requested: %s.', table) self.cur.execute('SELECT * FROM id_numbers WHERE tab == ?', [table]) fetch = self.cur.fetchone() if fetch is None: # Register new value new_id_int = 1 do_insert = True else: # Use database value new_id_int = int(fetch[SQL_LASTID['last_id']]) + 1 do_insert = False new_id = str(new_id_int).rjust(self.id_length, '0') if do_insert: self.cur.execute('INSERT INTO id_numbers VALUES(?, ?)', [table, new_id]) else: self.cur.execute('UPDATE id_numbers SET last_id = ? WHERE tab == ?', [new_id, table]) return new_id def get_thing_by_id(self, thing_type, thing_id): thing_map = self.thing_map(thing_type) if isinstance(thing_id, thing_map['class']): thing_id = thing_id.id query = 'SELECT * FROM %s WHERE id == ?' % thing_map['table'] self.cur.execute(query, [thing_id]) thing = self.cur.fetchone() if thing is None: return raise_no_such_thing(thing_map['exception'], thing_id=thing_id) thing = thing_map['class'](self, thing) return thing def get_things(self, thing_type, orderby=None): thing_map = self.thing_map(thing_type) if orderby: self.cur.execute('SELECT * FROM %s ORDER BY %s' % (thing_map['table'], orderby)) else: self.cur.execute('SELECT * FROM %s' % thing_map['table']) things = self.cur.fetchall() for thing in things: thing = thing_map['class'](self, row_tuple=thing) yield thing def thing_map(self, thing_type): return { 'album': { 'class': Album, 'exception': exceptions.NoSuchAlbum, 'table': 'albums', }, 'tag': { 'class': Tag, 'exception': exceptions.NoSuchTag, 'table': 'tags', }, 'photo': { 'class': Photo, 'exception': exceptions.NoSuchPhoto, 'table': 'photos', }, }[thing_type] #################################################################################################### #################################################################################################### class ObjectBase: def __eq__(self, other): return ( isinstance(other, type(self)) and self.photodb == other.photodb and self.id == other.id ) def __format__(self, formcode): if formcode == 'r': return repr(self) else: return str(self) def __hash__(self): return hash(self.id) class GroupableMixin: def add(self, member, *, commit=True): ''' Add a child object to this group. Child must be of the same type as the calling object. If that object is already a member of another group, an exceptions.GroupExists is raised. ''' if not isinstance(member, type(self)): raise TypeError('Member must be of type %s' % type(self)) self.photodb.cur.execute('SELECT * FROM tag_group_rel WHERE memberid == ?', [member.id]) fetch = self.photodb.cur.fetchone() if fetch is not None: if fetch[SQL_TAGGROUP['parentid']] == self.id: that_group = self else: that_group = self.group_getter(id=fetch[SQL_TAGGROUP['parentid']]) raise exceptions.GroupExists('%s already in group %s' % (member.name, that_group.name)) self.photodb._cached_frozen_children = None self.photodb.cur.execute('INSERT INTO tag_group_rel VALUES(?, ?)', [self.id, member.id]) if commit: log.debug('Commiting - add to group') self.photodb.commit() def children(self): self.photodb.cur.execute('SELECT * FROM tag_group_rel WHERE parentid == ?', [self.id]) fetch = self.photodb.cur.fetchall() results = [] for f in fetch: memberid = f[SQL_TAGGROUP['memberid']] child = self.group_getter(id=memberid) results.append(child) if isinstance(self, Tag): results.sort(key=lambda x: x.name) else: results.sort(key=lambda x: x.id) return results def delete(self, *, delete_children=False, commit=True): ''' Delete this object's relationships to other groupables. Any unique / specific deletion methods should be written within the inheriting class. For example, Tag.delete calls here to remove the group links, but then does the rest of the tag deletion process on its own. delete_children: If True, all children will be deleted. Otherwise they'll just be raised up one level. ''' self.photodb._cached_frozen_children = None if delete_children: for child in self.children(): child.delete(delete_children=delete_children, commit=False) else: # Lift children parent = self.parent() if parent is None: # Since this group was a root, children become roots by removing the row. self.photodb.cur.execute('DELETE FROM tag_group_rel WHERE parentid == ?', [self.id]) else: # Since this group was a child, its parent adopts all its children. self.photodb.cur.execute( 'UPDATE tag_group_rel SET parentid == ? WHERE parentid == ?', [parent.id, self.id] ) # Note that this part comes after the deletion of children to prevent issues of recursion. self.photodb.cur.execute('DELETE FROM tag_group_rel WHERE memberid == ?', [self.id]) if commit: log.debug('Committing - delete tag') self.photodb.commit() def parent(self): ''' Return the group of which this is a member, or None. Returned object will be of the same type as calling object. ''' self.photodb.cur.execute('SELECT * FROM tag_group_rel WHERE memberid == ?', [self.id]) fetch = self.photodb.cur.fetchone() if fetch is None: return None parentid = fetch[SQL_TAGGROUP['parentid']] return self.group_getter(id=parentid) def join_group(self, group, *, commit=True): ''' Leave the current group, then call `group.add(self)`. ''' if isinstance(group, str): group = self.photodb.get_tag(group) if not isinstance(group, type(self)): raise TypeError('Group must also be %s' % type(self)) if self == group: raise ValueError('Cant join self') self.leave_group(commit=commit) group.add(self, commit=commit) def leave_group(self, *, commit=True): ''' Leave the current group and become independent. ''' self.photodb._cached_frozen_children = None self.photodb.cur.execute('DELETE FROM tag_group_rel WHERE memberid == ?', [self.id]) if commit: log.debug('Committing - leave group') self.photodb.commit() def walk_children(self): yield self for child in self.children(): yield from child.walk_children() def walk_parents(self): parent = self.parent() while parent is not None: yield parent parent = parent.parent() class Album(ObjectBase, GroupableMixin): def __init__(self, photodb, row_tuple): self.photodb = photodb if isinstance(row_tuple, (list, tuple)): row_tuple = {SQL_ALBUM_COLUMNS[index]: value for (index, value) in enumerate(row_tuple)} self.id = row_tuple['id'] self.title = row_tuple['title'] self.description = row_tuple['description'] self.name = 'Album %s' % self.id self.group_getter = self.photodb.get_album def __repr__(self): return 'Album:{id}'.format(id=self.id) def add_photo(self, photo, *, commit=True): if self.photodb != photo.photodb: raise ValueError('Not the same PhotoDB') if self.has_photo(photo): return self.photodb.cur.execute('INSERT INTO album_photo_rel VALUES(?, ?)', [self.id, photo.id]) if commit: log.debug('Committing - add photo to album') self.photodb.commit() def add_tag_to_all(self, tag, *, nested_children=True, commit=True): tag = self.photodb.get_tag(tag) if nested_children: photos = self.walk_photos() else: photos = self.photos() for photo in photos: photo.add_tag(tag, commit=False) if commit: log.debug('Committing - add tag to all') self.photodb.commit() def delete(self, *, delete_children=False, commit=True): log.debug('Deleting album {album:r}'.format(album=self)) GroupableMixin.delete(self, delete_children=delete_children, commit=False) self.photodb.cur.execute('DELETE FROM albums WHERE id == ?', [self.id]) self.photodb.cur.execute('DELETE FROM album_photo_rel WHERE albumid == ?', [self.id]) if commit: log.debug('Committing - delete album') self.photodb.commit() def edit(self, title=None, description=None, *, commit=True): if title is None: title = self.title if description is None: description = self.description self.photodb.cur.execute( 'UPDATE albums SET title=?, description=? WHERE id == ?', [title, description, self.id] ) self.title = title self.description = description if commit: log.debug('Committing - edit album') self.photodb.commit() def has_photo(self, photo): if not isinstance(photo, Photo): raise TypeError('Must be a %s' % Photo) self.photodb.cur.execute( 'SELECT * FROM album_photo_rel WHERE albumid == ? AND photoid == ?', [self.id, photo.id] ) return self.photodb.cur.fetchone() is not None def photos(self): photos = [] generator = select( self.photodb.sql, 'SELECT * FROM album_photo_rel WHERE albumid == ?', [self.id] ) for photo in generator: photoid = photo[SQL_ALBUMPHOTO['photoid']] photo = self.photodb.get_photo(photoid) photos.append(photo) photos.sort(key=lambda x: x.basename.lower()) return photos def remove_photo(self, photo, *, commit=True): if not self.has_photo(photo): return self.photodb.cur.execute( 'DELETE FROM album_photo_rel WHERE albumid == ? AND photoid == ?', [self.id, photo.id] ) if commit: self.photodb.commit() def walk_photos(self): yield from self.photos() children = self.walk_children() # The first yield is itself next(children) for child in children: print(child) yield from child.walk_photos() class Photo(ObjectBase): ''' A PhotoDB entry containing information about an image file. Photo objects cannot exist without a corresponding PhotoDB object, because Photos are not the actual image data, just the database entry. ''' def __init__(self, photodb, row_tuple): self.photodb = photodb if isinstance(row_tuple, (list, tuple)): row_tuple = {SQL_PHOTO_COLUMNS[index]: value for (index, value) in enumerate(row_tuple)} self.id = row_tuple['id'] self.real_filepath = row_tuple['filepath'] self.real_filepath = normalize_filepath(self.real_filepath) self.real_path = pathclass.Path(self.real_filepath) self.filepath = row_tuple['override_filename'] or self.real_filepath self.basename = row_tuple['override_filename'] or os.path.basename(self.real_filepath) self.extension = row_tuple['extension'] self.width = row_tuple['width'] self.height = row_tuple['height'] self.ratio = row_tuple['ratio'] self.area = row_tuple['area'] self.bytes = row_tuple['bytes'] self.duration = row_tuple['duration'] self.created = row_tuple['created'] self.thumbnail = row_tuple['thumbnail'] self.tagged_at = row_tuple['tagged_at'] def __reinit__(self): ''' Reload the row from the database and do __init__ with them. ''' self.photodb.cur.execute('SELECT * FROM photos WHERE id == ?', [self.id]) row = self.photodb.cur.fetchone() self.__init__(self.photodb, row) def __repr__(self): return 'Photo:{id}'.format(id=self.id) def add_tag(self, tag, *, commit=True): tag = self.photodb.get_tag(tag) if self.has_tag(tag, check_children=False): return # If the tag is above one we already have, keep our current one. existing = self.has_tag(tag, check_children=True) if existing: log.debug('Preferring existing {exi:s} over {tag:s}'.format(exi=existing, tag=tag)) return # If the tag is beneath one we already have, remove our current one # in favor of the new, more specific tag. for parent in tag.walk_parents(): if self.has_tag(parent, check_children=False): log.debug('Preferring new {tag:s} over {par:s}'.format(tag=tag, par=parent)) self.remove_tag(parent) log.debug('Applying tag {tag:s} to photo {pho:s}'.format(tag=tag, pho=self)) now = int(getnow()) self.photodb.cur.execute('INSERT INTO photo_tag_rel VALUES(?, ?)', [self.id, tag.id]) self.photodb.cur.execute('UPDATE photos SET tagged_at = ? WHERE id == ?', [now, self.id]) if commit: log.debug('Committing - add photo tag') self.photodb.commit() def albums(self): ''' Return the albums of which this photo is a member. ''' self.photodb.cur.execute('SELECT albumid FROM album_photo_rel WHERE photoid == ?', [self.id]) fetch = self.photodb.cur.fetchall() albums = [self.photodb.get_album(f[0]) for f in fetch] return albums def bytestring(self): return bytestring.bytestring(self.bytes) def copy_tags(self, other_photo): for tag in other_photo.tags(): self.add_tag(tag) def delete(self, *, delete_file=False, commit=True): ''' Delete the Photo and its relation to any tags and albums. ''' log.debug('Deleting photo {photo:r}'.format(photo=self)) self.photodb.cur.execute('DELETE FROM photos WHERE id == ?', [self.id]) self.photodb.cur.execute('DELETE FROM photo_tag_rel WHERE photoid == ?', [self.id]) self.photodb.cur.execute('DELETE FROM album_photo_rel WHERE photoid == ?', [self.id]) if delete_file: path = self.real_path.absolute_path if commit: os.remove(path) else: queue_action = {'action': os.remove, 'args': [path]} self.photodb.on_commit_queue.append(queue_action) if commit: log.debug('Committing - delete photo') self.photodb.commit() @decorators.time_me def generate_thumbnail(self, *, commit=True, **special): ''' special: For videos, you can provide a `timestamp` to take the thumbnail from. ''' hopeful_filepath = self.make_thumbnail_filepath() return_filepath = None mime = self.mimetype() if mime == 'image': log.debug('Thumbnailing %s' % self.real_filepath) try: image = PIL.Image.open(self.real_filepath) image = image.convert('RGB') except (OSError, ValueError): pass else: (width, height) = image.size (new_width, new_height) = helpers.fit_into_bounds( image_width=width, image_height=height, frame_width=constants.THUMBNAIL_WIDTH, frame_height=constants.THUMBNAIL_HEIGHT, ) if new_width < width: image = image.resize((new_width, new_height)) image.save(hopeful_filepath, quality=50) return_filepath = hopeful_filepath elif mime == 'video' and ffmpeg: #print('video') probe = ffmpeg.probe(self.real_filepath) try: if probe.video: size = helpers.fit_into_bounds( image_width=probe.video.video_width, image_height=probe.video.video_height, frame_width=constants.THUMBNAIL_WIDTH, frame_height=constants.THUMBNAIL_HEIGHT, ) size = '%dx%d' % size duration = probe.video.duration if 'timestamp' in special: timestamp = special['timestamp'] else: if duration < 3: timestamp = 0 else: timestamp = 2 ffmpeg.thumbnail(self.real_filepath, time=timestamp, quality=2, size=size, outfile=hopeful_filepath) except: traceback.print_exc() else: return_filepath = hopeful_filepath if return_filepath != self.thumbnail: self.photodb.cur.execute('UPDATE photos SET thumbnail = ? WHERE id == ?', [return_filepath, self.id]) self.thumbnail = return_filepath if commit: log.debug('Committing - generate thumbnail') self.photodb.commit() self.__reinit__() return self.thumbnail def has_tag(self, tag, *, check_children=True): ''' Return the Tag object if this photo contains that tag. Otherwise return False. check_children: If True, children of the requested tag are counted ''' tag = self.photodb.get_tag(tag) if check_children: tags = tag.walk_children() else: tags = [tag] for tag in tags: self.photodb.cur.execute( 'SELECT * FROM photo_tag_rel WHERE photoid == ? AND tagid == ?', [self.id, tag.id] ) if self.photodb.cur.fetchone() is not None: return tag return False def make_thumbnail_filepath(self): chunked_id = helpers.chunk_sequence(self.id, 3) basename = chunked_id[-1] folder = chunked_id[:-1] folder = os.sep.join(folder) folder = os.path.join(self.photodb.thumbnail_directory, folder) if folder: os.makedirs(folder, exist_ok=True) hopeful_filepath = os.path.join(folder, basename) + '.jpg' return hopeful_filepath def mimetype(self): return helpers.get_mimetype(self.real_filepath) @decorators.time_me def reload_metadata(self, *, commit=True): ''' Load the file's height, width, etc as appropriate for this type of file. ''' self.bytes = os.path.getsize(self.real_filepath) self.width = None self.height = None self.area = None self.ratio = None self.duration = None mime = self.mimetype() if mime == 'image': try: image = PIL.Image.open(self.real_filepath) except (OSError, ValueError): log.debug('Failed to read image data for {photo:r}'.format(photo=self)) else: (self.width, self.height) = image.size image.close() log.debug('Loaded image data for {photo:r}'.format(photo=self)) elif mime == 'video' and ffmpeg: try: probe = ffmpeg.probe(self.real_filepath) if probe and probe.video: self.duration = probe.format.duration or probe.video.duration self.width = probe.video.video_width self.height = probe.video.video_height except: traceback.print_exc() elif mime == 'audio': try: probe = ffmpeg.probe(self.real_filepath) if probe and probe.audio: self.duration = probe.audio.duration except: traceback.print_exc() if self.width and self.height: self.area = self.width * self.height self.ratio = round(self.width / self.height, 2) self.photodb.cur.execute( 'UPDATE photos SET width=?, height=?, area=?, ratio=?, duration=?, bytes=? WHERE id==?', [self.width, self.height, self.area, self.ratio, self.duration, self.bytes, self.id], ) if commit: log.debug('Committing - reload metadata') self.photodb.commit() def remove_tag(self, tag, *, commit=True): tag = self.photodb.get_tag(tag) log.debug('Removing tag {t} from photo {p}'.format(t=repr(tag), p=repr(self))) tags = list(tag.walk_children()) for tag in tags: self.photodb.cur.execute( 'DELETE FROM photo_tag_rel WHERE photoid == ? AND tagid == ?', [self.id, tag.id] ) now = int(getnow()) self.photodb.cur.execute('UPDATE photos SET tagged_at = ? WHERE id == ?', [now, self.id]) if commit: log.debug('Committing - remove photo tag') self.photodb.commit() def rename_file(self, new_filename, *, move=False, commit=True): ''' Rename the file on the disk as well as in the database. If `move` is True, allow this operation to move the file. Otherwise, slashes will be considered an error. ''' old_path = self.real_path old_path.correct_case() new_filename = normalize_filepath(new_filename) if os.path.dirname(new_filename) == '': new_path = old_path.parent.with_child(new_filename) else: new_path = pathclass.Path(new_filename) new_path.correct_case() log.debug(old_path) log.debug(new_path) if (new_path.parent != old_path.parent) and not move: raise ValueError('Cannot move the file without param move=True') if new_path.absolute_path == old_path.absolute_path: raise ValueError('The new and old names are the same') os.makedirs(new_path.parent.absolute_path, exist_ok=True) if new_path != old_path: # This is different than the absolute == absolute check above, because this normalizes # the paths. It's possible on case-insensitive systems to have the paths point to the # same place while being differently cased, thus we couldn't make the intermediate link. try: os.link(old_path.absolute_path, new_path.absolute_path) except OSError: spinal.copy_file(old_path, new_path) self.photodb.cur.execute( 'UPDATE photos SET filepath = ? WHERE filepath == ?', [new_path.absolute_path, old_path.absolute_path] ) if commit: if new_path == old_path: # If they are equivalent but differently cased paths, just rename. os.rename(old_path.absolute_path, new_path.absolute_path) else: # Delete the original hardlink or copy. os.remove(old_path.absolute_path) log.debug('Committing - rename file') self.photodb.commit() else: queue_action = {'action': os.remove, 'args': [old_path.absolute_path]} self.photodb.on_commit_queue.append(queue_action) self.__reinit__() def tags(self): ''' Return the tags assigned to this Photo. ''' tags = [] generator = select( self.photodb.sql, 'SELECT * FROM photo_tag_rel WHERE photoid == ?', [self.id] ) for tag in generator: tagid = tag[SQL_PHOTOTAG['tagid']] tag = self.photodb.get_tag(id=tagid) tags.append(tag) return tags class Tag(ObjectBase, GroupableMixin): ''' A Tag, which can be applied to Photos for organization. ''' def __init__(self, photodb, row_tuple): self.photodb = photodb if isinstance(row_tuple, (list, tuple)): row_tuple = {SQL_TAG_COLUMNS[index]: value for (index, value) in enumerate(row_tuple)} self.id = row_tuple['id'] self.name = row_tuple['name'] self.group_getter = self.photodb.get_tag self._cached_qualified_name = None def __hash__(self): return hash(self.name) def __repr__(self): rep = 'Tag:{id}:{name}'.format(name=self.name, id=self.id) return rep def __str__(self): rep = 'Tag:{name}'.format(name=self.name) return rep def add_synonym(self, synname, *, commit=True): synname = normalize_tagname(synname) if synname == self.name: raise ValueError('Cannot assign synonym to itself.') try: self.photodb.get_tag_by_name(synname) except exceptions.NoSuchTag: pass else: raise exceptions.TagExists(synname) self.photodb._cached_frozen_children = None self.photodb.cur.execute('INSERT INTO tag_synonyms VALUES(?, ?)', [synname, self.name]) if commit: log.debug('Committing - add synonym') self.photodb.commit() def convert_to_synonym(self, mastertag, *, commit=True): ''' Convert an independent tag into a synonym for a different independent tag. All photos which possess the current tag will have it replaced with the new master tag. All synonyms of the old tag will point to the new tag. Good for when two tags need to be merged under a single name. ''' mastertag = self.photodb.get_tag(mastertag) # Migrate the old tag's synonyms to the new one # UPDATE is safe for this operation because there is no chance of duplicates. self.photodb._cached_frozen_children = None self.photodb.cur.execute( 'UPDATE tag_synonyms SET mastername = ? WHERE mastername == ?', [mastertag.name, self.name] ) # Iterate over all photos with the old tag, and swap them to the new tag # if they don't already have it. generator = select(self.photodb.sql, 'SELECT * FROM photo_tag_rel WHERE tagid == ?', [self.id]) for relationship in generator: photoid = relationship[SQL_PHOTOTAG['photoid']] self.photodb.cur.execute('SELECT * FROM photo_tag_rel WHERE photoid == ? AND tagid == ?', [photoid, mastertag.id]) if self.photodb.cur.fetchone() is None: self.photodb.cur.execute('INSERT INTO photo_tag_rel VALUES(?, ?)', [photoid, mastertag.id]) # Then delete the relationships with the old tag self.delete() # Enjoy your new life as a monk. mastertag.add_synonym(self.name, commit=False) if commit: log.debug('Committing - convert to synonym') self.photodb.commit() def delete(self, *, delete_children=False, commit=True): log.debug('Deleting tag {tag:r}'.format(tag=self)) self.photodb._cached_frozen_children = None GroupableMixin.delete(self, delete_children=delete_children, commit=False) self.photodb.cur.execute('DELETE FROM tags WHERE id == ?', [self.id]) self.photodb.cur.execute('DELETE FROM photo_tag_rel WHERE tagid == ?', [self.id]) self.photodb.cur.execute('DELETE FROM tag_synonyms WHERE mastername == ?', [self.name]) if commit: log.debug('Committing - delete tag') self.photodb.commit() def qualified_name(self): ''' Return the 'group1.group2.tag' string for this tag. ''' if self._cached_qualified_name: return self._cached_qualified_name qualname = self.name for parent in self.walk_parents(): qualname = parent.name + '.' + qualname self._cached_qualified_name = qualname return qualname def remove_synonym(self, synname, *, commit=True): ''' Delete a synonym. This will have no effect on photos or other synonyms because they always resolve to the master tag before application. ''' synname = normalize_tagname(synname) self.photodb.cur.execute('SELECT * FROM tag_synonyms WHERE name == ?', [synname]) fetch = self.photodb.cur.fetchone() if fetch is None: raise NoSuchSynonym(synname) self.photodb._cached_frozen_children = None self.photodb.cur.execute('DELETE FROM tag_synonyms WHERE name == ?', [synname]) if commit: log.debug('Committing - remove synonym') self.photodb.commit() def rename(self, new_name, *, apply_to_synonyms=True, commit=True): ''' Rename the tag. Does not affect its relation to Photos or tag groups. ''' new_name = normalize_tagname(new_name) if new_name == self.name: return try: self.photodb.get_tag(new_name) except exceptions.NoSuchTag: pass else: raise exceptions.TagExists(new_name) self._cached_qualified_name = None self.photodb._cached_frozen_children = None self.photodb.cur.execute('UPDATE tags SET name = ? WHERE id == ?', [new_name, self.id]) if apply_to_synonyms: self.photodb.cur.execute( 'UPDATE tag_synonyms SET mastername = ? WHERE mastername = ?', [new_name, self.name] ) self.name = new_name if commit: log.debug('Committing - rename tag') self.photodb.commit() def synonyms(self): self.photodb.cur.execute('SELECT name FROM tag_synonyms WHERE mastername == ?', [self.name]) fetch = self.photodb.cur.fetchall() fetch = [f[0] for f in fetch] fetch.sort() return fetch class User(ObjectBase): ''' A dear friend of ours. ''' def __init__(self, photodb, row_tuple): self.photodb = photodb if isinstance(row_tuple, (list, tuple)): row_tuple = {SQL_USER_COLUMNS[index]: value for (index, value) in enumerate(row_tuple)} self.id = row_tuple['id'] self.username = row_tuple['username'] self.created = row_tuple['created'] def __repr__(self): rep = 'User:{id}:{username}'.format(id=self.id, username=self.username) return rep def __str__(self): rep = 'User:{username}'.format(username=self.username) return rep if __name__ == '__main__': p = PhotoDB() print(p)