########################################################################## # # pgAdmin 4 - PostgreSQL Tools # # Copyright (C) 2013 - 2015, The pgAdmin Development Team # This software is released under the PostgreSQL Licence # ########################################################################## """Utility functions for storing and retrieving user configuration settings.""" from flask import current_app from flask.ext.login import current_user from flask.ext.sqlalchemy import SQLAlchemy from .settings_model import db, Setting import traceback from flask import Blueprint, Response, abort, request, render_template from flask.ext.security import login_required import config from pgadmin.utils.ajax import make_json_response from pgadmin.utils import PgAdminModule MODULE_NAME = 'settings' def store_setting(setting, value): """Set a configuration setting for the current user.""" data = Setting(user_id=current_user.id, setting=setting, value=value) db.session.merge(data) db.session.commit() def get_setting(setting, default=None): """Retrieve a configuration setting for the current user, or return the default value specified by the caller.""" data = Setting.query.filter_by(user_id=current_user.id, setting=setting).first() if not data or data.value is None: return default else: return data.value # Initialise the module blueprint = PgAdminModule(MODULE_NAME, __name__, template_folder='templates', url_prefix='/' + MODULE_NAME) @blueprint.route("/settings.js") @login_required def script(): """Render the required Javascript""" return Response(response=render_template("settings/settings.js"), status=200, mimetype="application/javascript") @blueprint.route("/store", methods=['POST']) @blueprint.route("/store//", methods=['GET']) @login_required def store(setting=None, value=None): """Store a configuration setting, or if this is a POST request and a count value is present, store multiple settings at once.""" success = 1 errorcode = 0 errormsg = '' try: if request.method == 'POST': if 'count' in request.form: for x in range(int(request.form['count'])): store_setting(request.form['setting%d' % (x+1)], request.form['value%d' % (x+1)]) else: store_setting(request.form['setting'], request.form['value']) else: store_setting(setting, value) except Exception as e: success = 0 errormsg = e.message try: info = traceback.format_exc() except Exception as e: info = str(e) return make_json_response(success=success, errormsg=errormsg, info=info, result=request.form) @blueprint.route("/get", methods=['POST']) @blueprint.route("/get/", methods=['GET']) @blueprint.route("/get//", methods=['GET']) @login_required def get(setting=None, default=None): """Get a configuration setting.""" if request.method == 'POST': setting = request.form['setting'] default = request.form['default'] success = 1 errorcode = 0 errormsg = '' try: value = get_setting(setting, default) except Exception as e: success = 0 errormsg = e.message try: info = traceback.format_exc() except Exception as e: info = str(e) return make_json_response(success=success, errormsg=errormsg, info=info, result=request.form)