Source code for flask_appbuilder.views

import json
import logging

from flask import (
    abort,
    flash,
    jsonify,
    make_response,
    redirect,
    request,
    send_file,
    session,
    url_for
)

from ._compat import as_unicode, string_types
from .baseviews import BaseCRUDView, BaseFormView, BaseView, expose, expose_api
from .const import FLAMSG_ERR_SEC_ACCESS_DENIED, PERMISSION_PREFIX
from .filemanager import uuid_originalname
from .security.decorators import has_access, has_access_api, permission_name
from .urltools import get_filter_args, get_order_args, get_page_args, get_page_size_args
from .widgets import GroupFormListWidget, ListMasterWidget

log = logging.getLogger(__name__)


[docs]class IndexView(BaseView): """ A simple view that implements the index for the site """ route_base = "" default_view = "index" index_template = "appbuilder/index.html" @expose("/") def index(self): self.update_redirect() return self.render_template(self.index_template, appbuilder=self.appbuilder)
class UtilView(BaseView): """ A simple view that implements special util routes. At the moment it only supports the back special endpoint. """ route_base = "" default_view = "back" @expose("/back") def back(self): return redirect(self.get_redirect())
[docs]class SimpleFormView(BaseFormView): """ View for presenting your own forms Inherit from this view to provide some base processing for your customized form views. Notice that this class inherits from BaseView so all properties from the parent class can be overridden also. Implement form_get and form_post to implement your form pre-processing and post-processing """ @expose("/form", methods=["GET"]) @has_access def this_form_get(self): self._init_vars() form = self.form.refresh() self.form_get(form) widgets = self._get_edit_widget(form=form) self.update_redirect() return self.render_template( self.form_template, title=self.form_title, widgets=widgets, appbuilder=self.appbuilder, ) @expose("/form", methods=["POST"]) @has_access def this_form_post(self): self._init_vars() form = self.form.refresh() if form.validate_on_submit(): response = self.form_post(form) if not response: return redirect(self.get_redirect()) return response else: widgets = self._get_edit_widget(form=form) return self.render_template( self.form_template, title=self.form_title, widgets=widgets, appbuilder=self.appbuilder, )
[docs]class PublicFormView(BaseFormView): """ View for presenting your own forms Inherit from this view to provide some base processing for your customized form views. Notice that this class inherits from BaseView so all properties from the parent class can be overridden also. Implement form_get and form_post to implement your form pre-processing and post-processing """ @expose("/form", methods=["GET"]) def this_form_get(self): self._init_vars() form = self.form.refresh() self.form_get(form) widgets = self._get_edit_widget(form=form) self.update_redirect() return self.render_template( self.form_template, title=self.form_title, widgets=widgets, appbuilder=self.appbuilder, ) @expose("/form", methods=["POST"]) def this_form_post(self): self._init_vars() form = self.form.refresh() if form.validate_on_submit(): response = self.form_post(form) if not response: return redirect(self.get_redirect()) return response else: widgets = self._get_edit_widget(form=form) return self.render_template( self.form_template, title=self.form_title, widgets=widgets, appbuilder=self.appbuilder, )
class RestCRUDView(BaseCRUDView): """ This class view exposes REST method for CRUD operations on you models """ def _search_form_json(self): pass def _get_api_urls(self, api_urls=None): """ Completes a dict with the CRUD urls of the API. :param api_urls: A dict with the urls {'<FUNCTION>':'<URL>',...} :return: A dict with the CRUD urls of the base API. """ view_name = self.__class__.__name__ api_urls = api_urls or {} api_urls["read"] = url_for(view_name + ".api_read") api_urls["delete"] = url_for(view_name + ".api_delete", pk="") api_urls["create"] = url_for(view_name + ".api_create") api_urls["update"] = url_for(view_name + ".api_update", pk="") return api_urls def _get_modelview_urls(self, modelview_urls=None): view_name = self.__class__.__name__ modelview_urls = modelview_urls or {} modelview_urls["show"] = url_for(view_name + ".show", pk="") modelview_urls["add"] = url_for(view_name + ".add") modelview_urls["edit"] = url_for(view_name + ".edit", pk="") return modelview_urls @expose("/api", methods=["GET"]) @has_access_api @permission_name("list") def api(self): log.warning("This API is deprecated and will be removed on 1.15.X") view_name = self.__class__.__name__ api_urls = self._get_api_urls() modelview_urls = self._get_modelview_urls() # # Collects the CRUD permissions can_show = self.appbuilder.sm.has_access("can_show", view_name) can_edit = self.appbuilder.sm.has_access("can_edit", view_name) can_add = self.appbuilder.sm.has_access("can_add", view_name) can_delete = self.appbuilder.sm.has_access("can_delete", view_name) # # Prepares the form with the search fields make it JSON serializable form_fields = {} search_filters = {} dict_filters = self._filters.get_search_filters() form = self.search_form.refresh() for col in self.search_columns: form_fields[col] = form[col]() search_filters[col] = [as_unicode(flt.name) for flt in dict_filters[col]] ret_json = jsonify( can_show=can_show, can_add=can_add, can_edit=can_edit, can_delete=can_delete, label_columns=self._label_columns_json(), list_columns=self.list_columns, order_columns=self.order_columns, page_size=self.page_size, modelview_name=view_name, api_urls=api_urls, search_filters=search_filters, search_fields=form_fields, modelview_urls=modelview_urls, ) response = make_response(ret_json, 200) response.headers["Content-Type"] = "application/json" return response @expose_api(name="read", url="/api/read", methods=["GET"]) @has_access_api @permission_name("list") def api_read(self): """ """ log.warning("This API is deprecated and will be removed on 2.3.X") # Get arguments for ordering if get_order_args().get(self.__class__.__name__): order_column, order_direction = get_order_args().get( self.__class__.__name__ ) else: order_column, order_direction = "", "" page = get_page_args().get(self.__class__.__name__) page_size = get_page_size_args().get(self.__class__.__name__) get_filter_args(self._filters) joined_filters = self._filters.get_joined_filters(self._base_filters) count, lst = self.datamodel.query( joined_filters, order_column, order_direction, page=page, page_size=page_size, ) result = self.datamodel.get_values_json(lst, self.list_columns) pks = self.datamodel.get_keys(lst) ret_json = jsonify( label_columns=self._label_columns_json(), list_columns=self.list_columns, order_columns=self.order_columns, page=page, page_size=page_size, count=count, modelview_name=self.__class__.__name__, pks=pks, result=result, ) response = make_response(ret_json, 200) response.headers["Content-Type"] = "application/json" return response def show_item_dict(self, item): """Returns a json-able dict for show""" d = {} for col in self.show_columns: v = getattr(item, col) if not isinstance(v, (int, float, string_types)): v = str(v) d[col] = v return d @expose_api(name="get", url="/api/get/<pk>", methods=["GET"]) @has_access_api @permission_name("show") def api_get(self, pk): """ """ log.warning("This API is deprecated and will be removed on 2.3.X") # Get arguments for ordering item = self.datamodel.get(pk, self._base_filters) if not item: abort(404) ret_json = jsonify( pk=pk, label_columns=self._label_columns_json(), include_columns=self.show_columns, modelview_name=self.__class__.__name__, result=self.show_item_dict(item), ) response = make_response(ret_json, 200) response.headers["Content-Type"] = "application/json" return response @expose_api(name="create", url="/api/create", methods=["POST"]) @has_access_api @permission_name("add") def api_create(self): log.warning("This API is deprecated and will be removed on 2.3.X") get_filter_args(self._filters) exclude_cols = self._filters.get_relation_cols() form = self.add_form.refresh() self._fill_form_exclude_cols(exclude_cols, form) if form.validate(): item = self.datamodel.obj() form.populate_obj(item) self.pre_add(item) if self.datamodel.add(item): self.post_add(item) http_return_code = 200 else: http_return_code = 500 payload = { "message": self.datamodel.message[0], "item": self.show_item_dict(item), "severity": self.datamodel.message[1], } else: payload = {"message": "Validation error", "error_details": form.errors} http_return_code = 500 return make_response(jsonify(payload), http_return_code) @expose_api(name="update", url="/api/update/<pk>", methods=["PUT"]) @has_access_api @permission_name("edit") def api_update(self, pk): log.warning("This API is deprecated and will be removed on 2.3.X") get_filter_args(self._filters) exclude_cols = self._filters.get_relation_cols() item = self.datamodel.get(pk, self._base_filters) if not item: abort(404) # convert pk to correct type, if pk is non string type. pk = self.datamodel.get_pk_value(item) form = self.edit_form.refresh(request.form) # fill the form with the suppressed cols, generated from exclude_cols self._fill_form_exclude_cols(exclude_cols, form) # trick to pass unique validation form._id = pk http_return_code = 500 if form.validate(): # Deleting form fields not specified as keys in POST data # this allows for other Model columns to be left untouched when # unspecified. form_fields = set([t for t in form._fields.keys()]) for field in form_fields - set(request.form.keys()): delattr(form, field) form.populate_obj(item) self.pre_update(item) if self.datamodel.edit(item): self.post_update(item) http_return_code = 200 payload = { "message": self.datamodel.message[0], "severity": self.datamodel.message[1], "item": self.show_item_dict(item), } else: payload = { "message": "Validation error", "error_details": form.errors, "severity": "warning", } return make_response(jsonify(payload), http_return_code) @expose_api(name="delete", url="/api/delete/<pk>", methods=["DELETE"]) @has_access_api @permission_name("delete") def api_delete(self, pk): log.warning("This API is deprecated and will be removed on 2.3.X") item = self.datamodel.get(pk, self._base_filters) if not item: abort(404) self.pre_delete(item) if self.datamodel.delete(item): self.post_delete(item) http_return_code = 200 else: http_return_code = 500 response = make_response( jsonify( { "message": self.datamodel.message[0], "severity": self.datamodel.message[1], } ), http_return_code, ) response.headers["Content-Type"] = "application/json" return response def _get_related_column_data(self, col_name, filters): rel_datamodel = self.datamodel.get_related_interface(col_name) _filters = rel_datamodel.get_filters(rel_datamodel.get_search_columns_list()) get_filter_args(_filters) if filters: filters = _filters.add_filter_list(filters) else: filters = _filters result = rel_datamodel.query(filters)[1] ret_list = list() for item in result: pk = rel_datamodel.get_pk_value(item) ret_list.append({"id": int(pk), "text": str(item)}) ret_json = json.dumps(ret_list) return ret_json @expose_api(name="column_add", url="/api/column/add/<col_name>", methods=["GET"]) @has_access_api @permission_name("add") def api_column_add(self, col_name): """ Returns list of (pk, object) nice to use on select2. Use only for related columns. Always filters with add_form_query_rel_fields, and accepts extra filters on endpoint arguments. :param col_name: The related column name :return: JSON response """ log.warning("This API is deprecated and will be removed on 2.3.X") filter_rel_fields = None if self.add_form_query_rel_fields: filter_rel_fields = self.add_form_query_rel_fields.get(col_name) ret_json = self._get_related_column_data(col_name, filter_rel_fields) response = make_response(ret_json, 200) response.headers["Content-Type"] = "application/json" return response @expose_api(name="column_edit", url="/api/column/edit/<col_name>", methods=["GET"]) @has_access_api @permission_name("edit") def api_column_edit(self, col_name): """ Returns list of (pk, object) nice to use on select2. Use only for related columns. Always filters with edit_form_query_rel_fields, and accepts extra filters on endpoint arguments. :param col_name: The related column name :return: JSON response """ log.warning("This API is deprecated and will be removed on 2.3.X") filter_rel_fields = None if self.edit_form_query_rel_fields: filter_rel_fields = self.edit_form_query_rel_fields ret_json = self._get_related_column_data(col_name, filter_rel_fields) response = make_response(ret_json, 200) response.headers["Content-Type"] = "application/json" return response @expose_api(name="readvalues", url="/api/readvalues", methods=["GET"]) @has_access_api @permission_name("list") def api_readvalues(self): """ """ log.warning("This API is deprecated and will be removed on 2.3.X") # Get arguments for ordering if get_order_args().get(self.__class__.__name__): order_column, order_direction = get_order_args().get( self.__class__.__name__ ) else: order_column, order_direction = "", "" get_filter_args(self._filters) joined_filters = self._filters.get_joined_filters(self._base_filters) count, result = self.datamodel.query( joined_filters, order_column, order_direction ) ret_list = list() for item in result: pk = self.datamodel.get_pk_value(item) ret_list.append({"id": int(pk), "text": str(item)}) ret_json = json.dumps(ret_list) response = make_response(ret_json, 200) response.headers["Content-Type"] = "application/json" return response
[docs]class ModelView(RestCRUDView): """ This is the CRUD generic view. If you want to automatically implement create, edit, delete, show, and list from your database tables, inherit your views from this class. Notice that this class inherits from BaseCRUDView and BaseModelView so all properties from the parent class can be overridden. """ def __init__(self, **kwargs): super(ModelView, self).__init__(**kwargs)
[docs] def post_add_redirect(self): """Override this function to control the redirect after add endpoint is called.""" return redirect(self.get_redirect())
[docs] def post_edit_redirect(self): """Override this function to control the redirect after edit endpoint is called.""" return redirect(self.get_redirect())
[docs] def post_delete_redirect(self): """Override this function to control the redirect after edit endpoint is called.""" return redirect(self.get_redirect())
""" -------------------------------- LIST -------------------------------- """ @expose("/list/") @has_access def list(self): widgets = self._list() return self.render_template( self.list_template, title=self.list_title, widgets=widgets ) """ -------------------------------- SHOW -------------------------------- """ @expose("/show/<pk>", methods=["GET"]) @has_access def show(self, pk): pk = self._deserialize_pk_if_composite(pk) widgets = self._show(pk) return self.render_template( self.show_template, pk=pk, title=self.show_title, widgets=widgets, related_views=self._related_views, ) """ --------------------------- ADD --------------------------- """ @expose("/add", methods=["GET", "POST"]) @has_access def add(self): widget = self._add() if not widget: return self.post_add_redirect() else: return self.render_template( self.add_template, title=self.add_title, widgets=widget ) """ --------------------------- EDIT --------------------------- """ @expose("/edit/<pk>", methods=["GET", "POST"]) @has_access def edit(self, pk): pk = self._deserialize_pk_if_composite(pk) widgets = self._edit(pk) if not widgets: return self.post_edit_redirect() else: return self.render_template( self.edit_template, title=self.edit_title, widgets=widgets, related_views=self._related_views, ) """ --------------------------- DELETE --------------------------- """ @expose("/delete/<pk>") @has_access def delete(self, pk): pk = self._deserialize_pk_if_composite(pk) self._delete(pk) return self.post_delete_redirect() @expose("/download/<string:filename>") @has_access def download(self, filename): return send_file( self.appbuilder.app.config["UPLOAD_FOLDER"] + filename, attachment_filename=uuid_originalname(filename), as_attachment=True, )
[docs] def get_action_permission_name(self, name: str) -> str: """ Get the permission name of an action name """ _permission_name = self.method_permission_name.get( self.actions.get(name).func.__name__ ) if _permission_name: return PERMISSION_PREFIX + _permission_name else: return name
[docs] @expose("/action/<string:name>/<pk>", methods=["GET"]) def action(self, name, pk): """ Action method to handle actions from a show view """ pk = self._deserialize_pk_if_composite(pk) permission_name = self.get_action_permission_name(name) if self.appbuilder.sm.has_access(permission_name, self.class_permission_name): action = self.actions.get(name) return action.func(self.datamodel.get(pk)) else: flash(as_unicode(FLAMSG_ERR_SEC_ACCESS_DENIED), "danger") return redirect(".")
[docs] @expose("/action_post", methods=["POST"]) def action_post(self): """ Action method to handle multiple records selected from a list view """ name = request.form["action"] pks = request.form.getlist("rowid") permission_name = self.get_action_permission_name(name) if self.appbuilder.sm.has_access(permission_name, self.class_permission_name): action = self.actions.get(name) items = [ self.datamodel.get(self._deserialize_pk_if_composite(pk)) for pk in pks ] return action.func(items) else: flash(as_unicode(FLAMSG_ERR_SEC_ACCESS_DENIED), "danger") return redirect(".")
[docs]class MasterDetailView(BaseCRUDView): """ Implements behaviour for controlling two CRUD views linked by PK and FK, in a master/detail type with two lists. Master view will behave like a left menu:: class DetailView(ModelView): datamodel = SQLAInterface(DetailTable, db.session) class MasterView(MasterDetailView): datamodel = SQLAInterface(MasterTable, db.session) related_views = [DetailView] """ list_template = "appbuilder/general/model/left_master_detail.html" list_widget = ListMasterWidget master_div_width = 2 """ Set to configure bootstrap class for master grid size """ @expose("/list/") @expose("/list/<pk>") @has_access def list(self, pk=None): pages = get_page_args() page_sizes = get_page_size_args() orders = get_order_args() widgets = self._list() if pk: item = self.datamodel.get(pk) widgets = self._get_related_views_widgets( item, orders=orders, pages=pages, page_sizes=page_sizes, widgets=widgets ) related_views = self._related_views else: related_views = [] return self.render_template( self.list_template, title=self.list_title, widgets=widgets, related_views=related_views, master_div_width=self.master_div_width, )
[docs]class MultipleView(BaseView): """ Use this view to render multiple views on the same page, exposed on the list endpoint. example (after defining GroupModelView and ContactModelView):: class MultipleViewsExp(MultipleView): views = [GroupModelView, ContactModelView] """ list_template = "appbuilder/general/model/multiple_views.html" """ Override this to implement your own template for the list endpoint """ views = None " A list of ModelView's to render on the same page " _views = None def __init__(self, **kwargs): super(MultipleView, self).__init__(**kwargs) self.views = self.views or list() self._views = self._views or list()
[docs] def get_uninit_inner_views(self): return self.views
[docs] def get_init_inner_views(self): return self._views
@expose("/list/") @has_access def list(self): pages = get_page_args() page_sizes = get_page_size_args() orders = get_order_args() views_widgets = list() for view in self._views: if orders.get(view.__class__.__name__): order_column, order_direction = orders.get(view.__class__.__name__) else: order_column, order_direction = "", "" page = pages.get(view.__class__.__name__) page_size = page_sizes.get(view.__class__.__name__) views_widgets.append( view._get_view_widget( filters=view._base_filters, order_column=order_column, order_direction=order_direction, page=page, page_size=page_size, ) ) self.update_redirect() return self.render_template( self.list_template, views=self._views, views_widgets=views_widgets )
[docs]class CompactCRUDMixin(BaseCRUDView): """ Mix with ModelView to implement a list with add and edit on the same page. """
[docs] @classmethod def set_key(cls, k, v): """Allows attaching stateless information to the class using the flask session dict """ k = cls.__name__ + "__" + k session[k] = v
[docs] @classmethod def get_key(cls, k, default=None): """Matching get method for ``set_key`` """ k = cls.__name__ + "__" + k if k in session: return session[k] else: return default
[docs] @classmethod def del_key(cls, k): """Matching get method for ``set_key`` """ k = cls.__name__ + "__" + k session.pop(k)
def _get_list_widget(self, **args): """ get joined base filter and current active filter for query """ widgets = super(CompactCRUDMixin, self)._get_list_widget(**args) session_form_widget = self.get_key("session_form_widget", None) form_widget = None if session_form_widget == "add": form_widget = self._add().get("add") elif session_form_widget == "edit": pk = self.get_key("session_form_edit_pk") if pk and self.datamodel.get(int(pk)): form_widget = self._edit(int(pk)).get("edit") return { "list": GroupFormListWidget( list_widget=widgets.get("list"), form_widget=form_widget, form_action=self.get_key("session_form_action", ""), form_title=self.get_key("session_form_title", ""), ) } @expose("/list/", methods=["GET", "POST"]) @has_access def list(self): list_widgets = self._list() return self.render_template( self.list_template, title=self.list_title, widgets=list_widgets ) @expose("/add/", methods=["GET", "POST"]) @has_access def add(self): widgets = self._add() if not widgets: self.set_key("session_form_action", "") self.set_key("session_form_widget", None) return redirect(request.referrer) else: self.set_key("session_form_widget", "add") self.set_key("session_form_action", request.script_root + request.full_path) self.set_key("session_form_title", self.add_title) return redirect(self.get_redirect()) @expose("/edit/<pk>", methods=["GET", "POST"]) @has_access def edit(self, pk): pk = self._deserialize_pk_if_composite(pk) widgets = self._edit(pk) self.update_redirect() if not widgets: self.set_key("session_form_action", "") self.set_key("session_form_widget", None) return redirect(self.get_redirect()) else: self.set_key("session_form_widget", "edit") self.set_key("session_form_action", request.script_root + request.full_path) self.set_key("session_form_title", self.add_title) self.set_key("session_form_edit_pk", pk) return redirect(self.get_redirect()) @expose("/delete/<pk>") @has_access def delete(self, pk): pk = self._deserialize_pk_if_composite(pk) self._delete(pk) edit_pk = self.get_key("session_form_edit_pk") if pk == edit_pk: self.del_key("session_form_edit_pk") return redirect(self.get_redirect())
""" This is for retro compatibility """ GeneralView = ModelView