Merge pull request #1288 from vToMy/feature_fileadmin_cols

Added sorting, labeling and visibility configuration to file admin columns

flask_admin/contrib/fileadmin/__init__.py

@@ -247,6 +247,28 @@ class BaseFileAdmin(BaseView, ActionsMixin):
     edit_modal = False
     """Setting this to true will display the edit view as a modal dialog."""
 
+    # List view
+    possible_columns = 'name', 'rel_path', 'is_dir', 'size', 'date'
+    """A list of possible columns to display."""
+
+    column_list = 'name', 'size', 'date'
+    """A list of columns to display."""
+
+    column_sortable_list = column_list
+    """A list of sortable columns."""
+
+    default_sort_column = None
+    """The default sort column."""
+
+    default_desc = 0
+    """The default desc value."""
+
+    column_labels = dict((column, column.capitalize()) for column in column_list)
+    """A dict from column names to their labels."""
+
+    date_format = '%Y-%m-%d %H:%M:%S'
+    """Date column display format."""
+
     def __init__(self, base_url=None, name=None, category=None, endpoint=None,
                  url=None, verify_path=True, menu_class_name=None,
                  menu_icon_type=None, menu_icon_value=None, storage=None):
@@ -670,6 +692,38 @@ class BaseFileAdmin(BaseView, ActionsMixin):
         """
         pass
 
+    def is_column_visible(self, column):
+        """
+        Determines if the given column is visible.
+        :param column: The column to query.
+        :return: Whether the column is visible.
+        """
+        return column in self.column_list
+
+    def is_column_sortable(self, column):
+        """
+        Determines if the given column is sortable.
+        :param column: The column to query.
+        :return: Whether the column is sortable.
+        """
+        return column in self.column_sortable_list
+
+    def column_label(self, column):
+        """
+        Gets the column's label.
+        :param column: The column to query.
+        :return: The column's label.
+        """
+        return self.column_labels[column]
+
+    def timestamp_format(self, timestamp):
+        """
+        Formats the timestamp to a date format.
+        :param timestamp: The timestamp to format.
+        :return: A formatted date.
+        """
+        return datetime.fromtimestamp(timestamp).strftime(self.date_format)
+
     def _save_form_files(self, directory, path, form):
         filename = self._separator.join([directory, secure_filename(form.upload.data.filename)])
 
@@ -739,14 +793,19 @@ class BaseFileAdmin(BaseView, ActionsMixin):
             if self.is_accessible_path(rel_path):
                 items.append(item)
 
-        # Sort by name
-        items.sort(key=itemgetter(0))
-
-        # Sort by type
-        items.sort(key=itemgetter(2), reverse=True)
+        sort_column = request.args.get('sort', None, type=str)
+        sort_desc = request.args.get('desc', 0, type=int)
 
-        # Sort by modified date
-        items.sort(key=lambda values: (values[0], values[1], values[2], values[3], datetime.fromtimestamp(values[4])), reverse=True)
+        if sort_column is None:
+            # Sort by name
+            items.sort(key=itemgetter(0))
+            # Sort by type
+            items.sort(key=itemgetter(2), reverse=True)
+            # Sort by modified date
+            items.sort(key=lambda values: (values[0], values[1], values[2], values[3], datetime.fromtimestamp(values[4])), reverse=True)
+        else:
+            column_index = self.possible_columns.index(sort_column)
+            items.sort(key=itemgetter(column_index), reverse=sort_desc)
 
         # Generate breadcrumbs
         breadcrumbs = self._get_breadcrumbs(path)
@@ -754,6 +813,14 @@ class BaseFileAdmin(BaseView, ActionsMixin):
         # Actions
         actions, actions_confirmation = self.get_actions_list()
 
+        def sort_url(column, invert=False):
+            desc = None
+
+            if invert and not sort_desc:
+                desc = 1
+
+            return self.get_url('.index_view', sort=column, desc=desc)
+
         return self.render(self.list_template,
                            dir_path=path,
                            breadcrumbs=breadcrumbs,
@@ -762,7 +829,11 @@ class BaseFileAdmin(BaseView, ActionsMixin):
                            items=items,
                            actions=actions,
                            actions_confirmation=actions_confirmation,
-                           delete_form=delete_form)
+                           delete_form=delete_form,
+                           sort_column=sort_column,
+                           sort_desc=sort_desc,
+                           sort_url=sort_url,
+                           timestamp_format=self.timestamp_format)
 
     @expose('/upload/', methods=('GET', 'POST'))
     @expose('/upload/<path:path>', methods=('GET', 'POST'))

flask_admin/templates/bootstrap2/admin/file/list.html

@@ -32,8 +32,26 @@
                 </th>
                 {% endif %}
                 <th class="span1">&nbsp;</th>
-                <th>{{ _gettext('Name') }}</th>
-                <th>{{ _gettext('Size') }}</th>
+                {% for column in admin_view.column_list %}
+                <th>
+                    {% if admin_view.is_column_sortable(column) %}
+                    {% if sort_column == column %}
+                        <a href="{{ sort_url(column, True) }}" title="{{ _gettext('Sort by %(name)s', name=column) }}">
+                            {{ admin_view.column_label(column) }}
+                            {% if sort_desc %}
+                                <i class="fa fa-chevron-up icon-chevron-up"></i>
+                            {% else %}
+                                <i class="fa fa-chevron-down icon-chevron-down"></i>
+                            {% endif %}
+                        </a>
+                    {% else %}
+                        <a href="{{ sort_url(column) }}" title="{{ _gettext('Sort by %(name)s', name=column) }}">{{ admin_view.column_label(column) }}</a>
+                    {% endif %}
+                    {% else %}
+                    {{ _gettext(admin_view.column_label(column)) }}
+                    {% endif %}
+                </th>
+                {% endfor %}
                 {% endblock %}
             </tr>
         </thead>
@@ -102,10 +120,17 @@
                   {{ name }}
                 {% endif %}
             </td>
+            {% if admin_view.is_column_visible('size') %}
             <td>
                 {{ size|filesizeformat }}
             </td>
             {% endif %}
+            {% if admin_view.is_column_visible('date') %}
+            <td>
+                {{ timestamp_format(date) }}
+            </td>
+            {% endif %}
+            {% endif %}
             {% endblock %}
         </tr>
         {% endfor %}

flask_admin/templates/bootstrap3/admin/file/list.html

@@ -32,8 +32,26 @@
                 </th>
                 {% endif %}
                 <th class="col-md-1">&nbsp;</th>
-                <th>{{ _gettext('Name') }}</th>
-                <th>{{ _gettext('Size') }}</th>
+                {% for column in admin_view.column_list %}
+                <th>
+                    {% if admin_view.is_column_sortable(column) %}
+                    {% if sort_column == column %}
+                        <a href="{{ sort_url(column, True) }}" title="{{ _gettext('Sort by %(name)s', name=column) }}">
+                            {{ admin_view.column_label(column) }}
+                            {% if sort_desc %}
+                                <span class="fa fa-chevron-up glyphicon glyphicon-chevron-up"></span>
+                            {% else %}
+                                <span class="fa fa-chevron-down glyphicon glyphicon-chevron-down"></span>
+                            {% endif %}
+                        </a>
+                    {% else %}
+                        <a href="{{ sort_url(column) }}" title="{{ _gettext('Sort by %(name)s', name=column) }}">{{ admin_view.column_label(column) }}</a>
+                    {% endif %}
+                    {% else %}
+                    {{ _gettext(admin_view.column_label(column)) }}
+                    {% endif %}
+                </th>
+                {% endfor %}
                 {% endblock %}
             </tr>
         </thead>
@@ -102,10 +120,17 @@
                   {{ name }}
                 {% endif %}
             </td>
+            {% if admin_view.is_column_visible('size') %}
             <td>
                 {{ size|filesizeformat }}
             </td>
             {% endif %}
+            {% if admin_view.is_column_visible('date') %}
+            <td>
+                {{ timestamp_format(date) }}
+            </td>
+            {% endif %}
+            {% endif %}
             {% endblock %}
         </tr>
         {% endfor %}