import flask; from flask import request import os import subprocess import traceback import urllib.parse from voussoirkit import cacheclass from voussoirkit import flasktools from voussoirkit import pathclass from voussoirkit import stringtools from voussoirkit import vlogging log = vlogging.get_logger(__name__) import etiquette from .. import common from .. import helpers site = common.site session_manager = common.session_manager photo_download_zip_tokens = cacheclass.Cache(maxlen=100) # Individual photos ################################################################################ @site.route('/photo/') def get_photo_html(photo_id): photo = common.P_photo(photo_id, response_type='html') return common.render_template(request, 'photo.html', photo=photo) @site.route('/photo/.json') def get_photo_json(photo_id): photo = common.P_photo(photo_id, response_type='json') photo = photo.jsonify() photo = flasktools.json_response(photo) return photo @site.route('/file/') @site.route('/file//') def get_file(photo_id, basename=None): photo_id = photo_id.split('.')[0] photo = common.P.get_photo(photo_id) do_download = request.args.get('download', False) do_download = stringtools.truthystring(do_download) use_original_filename = request.args.get('original_filename', False) use_original_filename = stringtools.truthystring(use_original_filename) if do_download: if use_original_filename: download_as = photo.basename else: download_as = photo.id + photo.dot_extension download_as = etiquette.helpers.remove_path_badchars(download_as) download_as = urllib.parse.quote(download_as) response = flask.make_response(common.send_file(photo.real_path.absolute_path)) response.headers['Content-Disposition'] = 'attachment; filename*=UTF-8\'\'%s' % download_as return response else: return common.send_file(photo.real_path.absolute_path, override_mimetype=photo.mimetype) @site.route('/thumbnail/') def get_thumbnail(photo_id): photo_id = photo_id.split('.')[0] photo = common.P_photo(photo_id, response_type='html') if photo.thumbnail: path = photo.thumbnail else: flask.abort(404, 'That file doesnt have a thumbnail') return common.send_file(path) # Photo create and delete ########################################################################## @site.route('/photo//delete', methods=['POST']) def post_photo_delete(photo_id): delete_file = request.form.get('delete_file', False) delete_file = stringtools.truthystring(delete_file) with common.P.transaction: photo = common.P_photo(photo_id, response_type='json') photo.delete(delete_file=delete_file) return flasktools.json_response({}) # Photo tag operations ############################################################################# def post_photo_add_remove_tag_core(photo_ids, tagname, add_or_remove): if isinstance(photo_ids, str): photo_ids = stringtools.comma_space_split(photo_ids) photos = list(common.P_photos(photo_ids, response_type='json')) tag = common.P_tag(tagname, response_type='json') with common.P.transaction: for photo in photos: if add_or_remove == 'add': photo.add_tag(tag) elif add_or_remove == 'remove': photo.remove_tag(tag) response = {'action': add_or_remove, 'tagname': tag.name} return flasktools.json_response(response) @site.route('/photo//add_tag', methods=['POST']) @flasktools.required_fields(['tagname'], forbid_whitespace=True) def post_photo_add_tag(photo_id): ''' Add a tag to this photo. ''' response = post_photo_add_remove_tag_core( photo_ids=photo_id, tagname=request.form['tagname'], add_or_remove='add', ) return response @site.route('/photo//copy_tags', methods=['POST']) @flasktools.required_fields(['other_photo'], forbid_whitespace=True) def post_photo_copy_tags(photo_id): ''' Copy the tags from another photo. ''' with common.P.transaction: photo = common.P_photo(photo_id, response_type='json') other = common.P_photo(request.form['other_photo'], response_type='json') photo.copy_tags(other) return flasktools.json_response([tag.jsonify(minimal=True) for tag in photo.get_tags()]) @site.route('/photo//remove_tag', methods=['POST']) @flasktools.required_fields(['tagname'], forbid_whitespace=True) def post_photo_remove_tag(photo_id): ''' Remove a tag from this photo. ''' response = post_photo_add_remove_tag_core( photo_ids=photo_id, tagname=request.form['tagname'], add_or_remove='remove', ) return response @site.route('/batch/photos/add_tag', methods=['POST']) @flasktools.required_fields(['photo_ids', 'tagname'], forbid_whitespace=True) def post_batch_photos_add_tag(): response = post_photo_add_remove_tag_core( photo_ids=request.form['photo_ids'], tagname=request.form['tagname'], add_or_remove='add', ) return response @site.route('/batch/photos/remove_tag', methods=['POST']) @flasktools.required_fields(['photo_ids', 'tagname'], forbid_whitespace=True) def post_batch_photos_remove_tag(): response = post_photo_add_remove_tag_core( photo_ids=request.form['photo_ids'], tagname=request.form['tagname'], add_or_remove='remove', ) return response # Photo metadata operations ######################################################################## @site.route('/photo//generate_thumbnail', methods=['POST']) def post_photo_generate_thumbnail(photo_id): special = request.form.to_dict() with common.P.transaction: photo = common.P_photo(photo_id, response_type='json') photo.generate_thumbnail(**special) response = flasktools.json_response({}) return response def post_photo_refresh_metadata_core(photo_ids): if isinstance(photo_ids, str): photo_ids = stringtools.comma_space_split(photo_ids) with common.P.transaction: photos = list(common.P_photos(photo_ids, response_type='json')) for photo in photos: photo._uncache() photo = common.P_photo(photo.id, response_type='json') try: photo.reload_metadata() except pathclass.NotFile: flask.abort(404) if photo.thumbnail is None: try: photo.generate_thumbnail() except Exception: log.warning(traceback.format_exc()) return flasktools.json_response({}) @site.route('/photo//refresh_metadata', methods=['POST']) def post_photo_refresh_metadata(photo_id): response = post_photo_refresh_metadata_core(photo_ids=photo_id) return response @site.route('/batch/photos/refresh_metadata', methods=['POST']) @flasktools.required_fields(['photo_ids'], forbid_whitespace=True) def post_batch_photos_refresh_metadata(): response = post_photo_refresh_metadata_core(photo_ids=request.form['photo_ids']) return response @site.route('/photo//set_searchhidden', methods=['POST']) def post_photo_set_searchhidden(photo_id): with common.P.transaction: photo = common.P_photo(photo_id, response_type='json') photo.set_searchhidden(True) return flasktools.json_response({}) @site.route('/photo//unset_searchhidden', methods=['POST']) def post_photo_unset_searchhidden(photo_id): with common.P.transaction: photo = common.P_photo(photo_id, response_type='json') photo.set_searchhidden(False) return flasktools.json_response({}) def post_batch_photos_searchhidden_core(photo_ids, searchhidden): if isinstance(photo_ids, str): photo_ids = stringtools.comma_space_split(photo_ids) with common.P.transaction: photos = list(common.P_photos(photo_ids, response_type='json')) for photo in photos: photo.set_searchhidden(searchhidden) return flasktools.json_response({}) @site.route('/photo//show_in_folder', methods=['POST']) def post_photo_show_in_folder(photo_id): if not request.is_localhost: flask.abort(403) photo = common.P_photo(photo_id, response_type='json') if os.name == 'nt': command = f'explorer.exe /select,"{photo.real_path.absolute_path}"' subprocess.Popen(command, shell=True) return flasktools.json_response({}) else: command = ['xdg-open', photo.real_path.parent.absolute_path] subprocess.Popen(command, shell=True) return flasktools.json_response({}) flask.abort(501) @site.route('/batch/photos/set_searchhidden', methods=['POST']) @flasktools.required_fields(['photo_ids'], forbid_whitespace=True) def post_batch_photos_set_searchhidden(): photo_ids = request.form['photo_ids'] response = post_batch_photos_searchhidden_core(photo_ids=photo_ids, searchhidden=True) return response @site.route('/batch/photos/unset_searchhidden', methods=['POST']) @flasktools.required_fields(['photo_ids'], forbid_whitespace=True) def post_batch_photos_unset_searchhidden(): photo_ids = request.form['photo_ids'] response = post_batch_photos_searchhidden_core(photo_ids=photo_ids, searchhidden=False) return response # Clipboard ######################################################################################## @site.route('/clipboard') def get_clipboard_page(): return common.render_template(request, 'clipboard.html') @site.route('/batch/photos', methods=['POST']) @flasktools.required_fields(['photo_ids'], forbid_whitespace=True) def post_batch_photos(): ''' Return a list of photo.jsonify() for each requested photo id. ''' photo_ids = request.form['photo_ids'] photo_ids = stringtools.comma_space_split(photo_ids) photos = list(common.P_photos(photo_ids, response_type='json')) photos = [photo.jsonify() for photo in photos] response = flasktools.json_response(photos) return response @site.route('/batch/photos/photo_card', methods=['POST']) @flasktools.required_fields(['photo_ids'], forbid_whitespace=True) def post_batch_photos_photo_cards(): photo_ids = request.form['photo_ids'] photo_ids = stringtools.comma_space_split(photo_ids) photos = list(common.P_photos(photo_ids, response_type='json')) # Photo filenames are prevented from having colons, so using it as a split # delimiter should be safe. template = ''' {% import "cards.html" as cards %} {% for photo in photos %} {{photo.id}}: {{cards.create_photo_card(photo)}} :SPLITME: {% endfor %} ''' html = flask.render_template_string(template, photos=photos) divs = [div.strip() for div in html.split(':SPLITME:')] divs = [div for div in divs if div] divs = [div.split(':', 1) for div in divs] divs = {photo_id.strip(): photo_card.strip() for (photo_id, photo_card) in divs} response = flasktools.json_response(divs) return response # Zipping ########################################################################################## @site.route('/batch/photos/download_zip/', methods=['GET']) def get_batch_photos_download_zip(zip_token): ''' After the user has generated their zip token, they can retrieve that zip file. ''' zip_token = zip_token.split('.')[0] try: photo_ids = photo_download_zip_tokens[zip_token] except KeyError: flask.abort(404) # Let's re-validate those IDs just in case anything has changed. photos = list(common.P_photos(photo_ids, response_type='json')) if not photos: flask.abort(400) streamed_zip = etiquette.helpers.zip_photos(photos) download_as = zip_token + '.zip' download_as = urllib.parse.quote(download_as) outgoing_headers = { 'Content-Type': 'application/octet-stream', 'Content-Disposition': f'attachment; filename*=UTF-8\'\'{download_as}', } return flask.Response(streamed_zip, headers=outgoing_headers) @site.route('/batch/photos/download_zip', methods=['POST']) @flasktools.required_fields(['photo_ids'], forbid_whitespace=True) def post_batch_photos_download_zip(): ''' Initiating file downloads via POST requests is a bit clunky and unreliable, so the way this works is we generate a token representing the photoset that they want, and then they can retrieve the zip itself via GET. ''' photo_ids = request.form['photo_ids'] photo_ids = stringtools.comma_space_split(photo_ids) photos = list(common.P_photos(photo_ids, response_type='json')) if not photos: flask.abort(400) photo_ids = [p.id for p in photos] zip_token = 'etiquette_' + etiquette.helpers.hash_photoset(photos) photo_download_zip_tokens[zip_token] = photo_ids response = {'zip_token': zip_token} response = flasktools.json_response(response) return response # Search ########################################################################################### def get_search_core(): warning_bag = etiquette.objects.WarningBag() has_tags = request.args.get('has_tags') tag_musts = request.args.get('tag_musts') tag_mays = request.args.get('tag_mays') tag_forbids = request.args.get('tag_forbids') tag_expression = request.args.get('tag_expression') filename_terms = request.args.get('filename') extension = request.args.get('extension') extension_not = request.args.get('extension_not') mimetype = request.args.get('mimetype') sha256 = request.args.get('sha256') is_searchhidden = request.args.get('is_searchhidden', False) yield_albums = request.args.get('yield_albums', True) yield_photos = request.args.get('yield_photos', True) limit = request.args.get('limit') # This is being pre-processed because the site enforces a maximum value # which the PhotoDB api does not. limit = etiquette.searchhelpers.normalize_limit(limit, warning_bag=warning_bag) if limit is None: limit = 50 else: limit = min(limit, 1000) offset = request.args.get('offset') author = request.args.get('author') orderby = request.args.get('orderby') area = request.args.get('area') width = request.args.get('width') height = request.args.get('height') aspectratio = request.args.get('aspectratio') bytes = request.args.get('bytes') has_albums = request.args.get('has_albums') has_thumbnail = request.args.get('has_thumbnail') duration = request.args.get('duration') bitrate = request.args.get('bitrate') created = request.args.get('created') # These are in a dictionary so I can pass them to the page template. search_kwargs = { 'area': area, 'width': width, 'height': height, 'aspectratio': aspectratio, 'bytes': bytes, 'duration': duration, 'bitrate': bitrate, 'author': author, 'created': created, 'extension': extension, 'extension_not': extension_not, 'filename': filename_terms, 'has_albums': has_albums, 'has_tags': has_tags, 'has_thumbnail': has_thumbnail, 'is_searchhidden': is_searchhidden, 'mimetype': mimetype, 'sha256': sha256, 'tag_musts': tag_musts, 'tag_mays': tag_mays, 'tag_forbids': tag_forbids, 'tag_expression': tag_expression, 'limit': limit, 'offset': offset, 'orderby': orderby, 'warning_bag': warning_bag, 'give_back_parameters': True, 'yield_albums': yield_albums, 'yield_photos': yield_photos, } # print(search_kwargs) search_generator = common.P.search(**search_kwargs) # Because of the giveback, first element is cleaned up kwargs search_kwargs = next(search_generator) # Web UI users aren't allowed to use within_directory anyway, so don't # show it to them. search_kwargs.pop('within_directory', None) # print(search_kwargs) warnings = set() search_results = [] for item in search_generator: if isinstance(item, etiquette.objects.WarningBag): warnings.update(item.warnings) continue search_results.append(item) warnings = [ w.error_message if hasattr(w, 'error_message') else str(w) for w in warnings ] # TAGS ON THIS PAGE total_tags = set() for result in search_results: if isinstance(result, etiquette.objects.Photo): total_tags.update(result.get_tags()) total_tags = sorted(total_tags, key=lambda t: t.name) # PREV-NEXT PAGE URLS offset = search_kwargs['offset'] or 0 original_params = request.args.to_dict() original_params['limit'] = limit if limit and len(search_results) >= limit: next_params = original_params.copy() next_params['offset'] = offset + limit next_params = helpers.dict_to_params(next_params) next_page_url = '/search' + next_params else: next_page_url = None if limit and offset > 0: prev_params = original_params.copy() prev_offset = max(0, offset - limit) if prev_offset > 0: prev_params['offset'] = prev_offset else: prev_params.pop('offset', None) prev_params = helpers.dict_to_params(prev_params) prev_page_url = '/search' + prev_params else: prev_page_url = None search_kwargs['view'] = request.args.get('view', 'grid') final_results = { 'next_page_url': next_page_url, 'prev_page_url': prev_page_url, 'results': search_results, 'total_tags': total_tags, 'warnings': list(warnings), 'search_kwargs': search_kwargs, } return final_results @site.route('/search_embed') def get_search_embed(): search_results = get_search_core() response = common.render_template( request, 'search_embed.html', results=search_results['results'], search_kwargs=search_results['search_kwargs'], ) return response @site.route('/search') def get_search_html(): search_results = get_search_core() response = common.render_template( request, 'search.html', next_page_url=search_results['next_page_url'], prev_page_url=search_results['prev_page_url'], results=search_results['results'], search_kwargs=search_results['search_kwargs'], total_tags=search_results['total_tags'], warnings=search_results['warnings'], ) return response @site.route('/search.atom') def get_search_atom(): search_results = get_search_core()['results'] soup = etiquette.helpers.make_atom_feed( search_results, feed_id=request.query_string.decode('utf-8'), feed_title='etiquette search', feed_link=request.url.replace('/search.atom', '/search'), ) outgoing_headers = { 'Content-Type': 'application/atom+xml; charset=utf-8', } response = flask.Response(str(soup), headers=outgoing_headers) return response @site.route('/search.json') def get_search_json(): search_results = get_search_core() search_kwargs = search_results['search_kwargs'] # The search has converted many arguments into sets or other types. # Convert them back into something that will display nicely on the search form. join_helper = lambda x: ', '.join(x) if x else None search_kwargs['extension'] = join_helper(search_kwargs['extension']) search_kwargs['extension_not'] = join_helper(search_kwargs['extension_not']) search_kwargs['mimetype'] = join_helper(search_kwargs['mimetype']) author_helper = lambda users: ', '.join(user.username for user in users) if users else None search_kwargs['author'] = author_helper(search_kwargs['author']) tagname_helper = lambda tags: [tag.name for tag in tags] if tags else None search_kwargs['tag_musts'] = tagname_helper(search_kwargs['tag_musts']) search_kwargs['tag_mays'] = tagname_helper(search_kwargs['tag_mays']) search_kwargs['tag_forbids'] = tagname_helper(search_kwargs['tag_forbids']) search_results['results'] = [ result.jsonify(include_albums=False) if isinstance(result, etiquette.objects.Photo) else result.jsonify(minimal=True) for result in search_results['results'] ] search_results['total_tags'] = [ tag.jsonify(minimal=True) for tag in search_results['total_tags'] ] return flasktools.json_response(search_results) # Swipe ############################################################################################ @site.route('/swipe') def get_swipe(): response = common.render_template(request, 'swipe.html') return response