Add support for hidden attachment folders #3181

bpedersen2 · 2017-12-11T07:52:33Z

Not all uploaded files need to be shown in the materials listing
on the event front page, sometimes it should only be used for links
at some place in the event. Allow to always hide folders in the
frontend indepently from the access rights.

Fixes: #3180

bpedersen2 · 2017-12-11T07:53:46Z

indico/migrations/versions/20171211_0811_03dca79b401c_hidden_folders_support.py

+    # ### commands auto generated by Alembic  ###
+    op.add_column('folders', sa.Column('is_always_hidden_in_fe', sa.Boolean(), nullable=False, server_default='false'),
+                  schema='attachments')
+    op.alter_column('folders', 'is_always_hidden_in_fe', server_default=None, schema='attachments')


Question: Is there something to be done to force the mutual exclusive setting of hide_in_fe and always_visible at the database level?

mic4ael · 2017-12-11T07:55:12Z

indico/migrations/versions/20171211_0811_03dca79b401c_hidden_folders_support.py

+
+
+def upgrade():
+    # ### commands auto generated by Alembic  ###


You can remove the comments from upgrade and downgrade functions.

mic4ael · 2017-12-11T08:00:23Z

On a side note you don't have to create a separate commit for each fix/change which is a result of a comment. You could easily use either git commit --amend or interactive rebase along with squash operation.

ThiefMaster · 2017-12-11T08:20:07Z

indico/modules/attachments/models/folders.py

@@ -91,6 +91,14 @@ def __table_args__(cls):
        default=True
    )

+    #: If the folder is never shown in the frontend (even if you can access it)
+    is_always_hidden_in_fe = db.Column(


I kind of dislike this name. It's not very clear without reading the comment, and also too verbose. IMO is_hidden is a much better name for it. (also, we don't put an empty line between column definitions, and only one empty line between columns and relationships)

Changed to is_hidden_in_fe .

I think the _in_fe is not very useful either; that's something worth mentioning in the docstring on top of it (like it already does)

Ok, using is_hidden now

ThiefMaster · 2017-12-11T08:21:05Z

indico/modules/attachments/util.py

@@ -36,7 +36,7 @@ def get_attached_folders(linked_object, include_empty=True, include_hidden=True,
    folders = AttachmentFolder.get_for_linked_object(linked_object, preload_event=preload_event)

    if not include_hidden:
-        folders = [f for f in folders if f.can_view(session.user)]
+        folders = [f for f in folders if (f.can_view(session.user) and not f.is_always_hidden_in_fe)]


This check can be done in can_view

ThiefMaster · 2017-12-11T08:21:49Z

indico/modules/attachments/forms.py

                                     description=_("By default, folders are always visible, even if a user cannot "
                                                   "access them. You can disable this behavior here, hiding the folder "
                                                   "for anyone who does not have permission to access it."))
+    is_always_hidden_in_fe = BooleanField(_("Always Hidden in Frontend"),
+                                          [HiddenUnless('is_always_visible', value=False), ],


no need for the , at the end of the list - only single-element tuples need this.

pferreir · 2017-12-11T14:49:07Z

indico/modules/attachments/forms.py

                                     description=_("By default, folders are always visible, even if a user cannot "
                                                   "access them. You can disable this behavior here, hiding the folder "
                                                   "for anyone who does not have permission to access it."))
+    is_hidden = BooleanField(_("Always Hidden in Frontend"),


Hi,
I'm not that sure about the wording here. "Frontend" is not a term that a end user will necessarily understand.

I discussed it briefly with @ThiefMaster, "Hide in event page" or similar could be an option.

ThiefMaster · 2017-12-11T15:29:30Z

indico/modules/attachments/templates/_attachments.html

@@ -64,6 +64,14 @@
                   title="{% trans %}The access to this folder is restricted, regardless of the protection scheme of
                          the parent.{% endtrans %}"></i>
            {% endif %}
+            {% if folder.is_hidden and management%}


missing space before %}

ThiefMaster · 2017-12-11T15:29:30Z

indico/modules/attachments/templates/_attachments.html

@@ -64,6 +64,14 @@
                   title="{% trans %}The access to this folder is restricted, regardless of the protection scheme of
                          the parent.{% endtrans %}"></i>
            {% endif %}
+            {% if folder.is_hidden and management%}
+                <i class=" icon-eye-blocked"
+                title="{% trans %}This folder is always hidden in the frontend.{% endtrans %}"></i>


not enough indentation (attrs should be aligned)

ThiefMaster · 2017-12-11T15:29:43Z

indico/modules/attachments/templates/_attachments.html

@@ -64,6 +64,14 @@
                   title="{% trans %}The access to this folder is restricted, regardless of the protection scheme of
                          the parent.{% endtrans %}"></i>
            {% endif %}
+            {% if folder.is_hidden and management%}
+                <i class=" icon-eye-blocked"


there shouldn't be a space right after the opening quote

ThiefMaster · 2017-12-11T15:30:51Z

indico/modules/attachments/templates/_attachments.html

+            {% endif %}
+            {% if folder.is_always_visible and management%}
+                <i class=" icon-eye"
+                title="{% trans %}This folder is always visible in the frontend.{% endtrans %}"></i>


Maybe this is a bit noisy since it's enabled by default? Explicitly showing the hidden flag makes sense but for this one I'm not sure if there's any benefit

Well, it is only shown in managment views. And for symmetry ( all other flags one can set on a folder are indicated) I think it is helpful.

ThiefMaster · 2017-12-11T15:31:54Z

indico/modules/attachments/models/folders.py

+        nullable=False,
+        default=False
+    )
+


one linebreak too much (there should be one empty line between this and the the relationships)

ThiefMaster · 2017-12-11T15:33:43Z

indico/migrations/versions/20171211_0811_03dca79b401c_hidden_folders_support.py

+    op.add_column('folders', sa.Column('is_hidden', sa.Boolean(), nullable=False, server_default='false'),
+                  schema='attachments')
+    op.alter_column('folders', 'is_hidden', server_default=None, schema='attachments')
+    op.create_check_constraint('ck_folders_exclusive_is_hidden_is_always_visible', 'folders',


Not sure if a DB constraint is really important here - there is no harm if both are set for some reason.

Anyway, if you want to keep it, make sure to add it to the model as well!

Added constraint to model as well. I think this is needed, as both switches would get hidden if both flags are set in the db. Then the only way to recover would be to edit values in the database by hand.

Good point indeed!

BTW: This should be validated on the Form level as well; i'll add a snippet to the comment once i'm in the office.

def validate_is_always_visible(self, field): if self.is_always_visible.data and self.is_hidden.data: raise ValidationError('These two options cannot be used at the same time') validate_is_hidden = validate_is_always_visible

ThiefMaster · 2017-12-12T09:52:26Z

indico/modules/attachments/models/folders.py

@@ -50,7 +50,7 @@ def __auto_table_args():
        return (db.CheckConstraint(default_inheriting, 'default_inheriting'),
                db.CheckConstraint('is_default = (title IS NULL)', 'default_or_title'),
                db.CheckConstraint('not (is_default and is_deleted)', 'default_not_deleted'),
-                {'schema': 'attachments'})


what happened to this?!

Lost due to mis-reading braces..., readded

ThiefMaster · 2017-12-12T09:52:34Z

indico/modules/attachments/models/folders.py

@@ -161,6 +167,8 @@ def can_view(self, user):
        """
        if not self.object.can_access(user):
            return False
+        if self.is_hidden:


do this before the access check; it's much cheaper!

bpedersen2 · 2018-01-29T07:44:03Z

Bumped migrations

ThiefMaster · 2018-02-12T11:53:25Z

indico/migrations/versions/20180129_0842_813ea74ce8dc_hidden_folders_support.py

+                               'NOT (is_hidden AND is_always_visible)', schema='attachments')
+
+
+def validate_is_always_visible(self, field):


this doesn't belong in here

Not all uploaded files need to be shown in the materials listing on the event front page, sometimes it should only be used for links at some place in the event. Allow to always hide folders in the frontend indepently from the access rights. Fixes: indico#3180

If in management mode, indicate forced visibiliy/invisibility using an (striked-out) eye-icon.

bpedersen2 commented Dec 11, 2017

View reviewed changes

mic4ael reviewed Dec 11, 2017

View reviewed changes

ThiefMaster reviewed Dec 11, 2017

View reviewed changes

bpedersen2 force-pushed the hiddenfolders branch 2 times, most recently from 52c3c32 to b1422b0 Compare December 11, 2017 08:48

pferreir reviewed Dec 11, 2017

View reviewed changes

ThiefMaster requested changes Dec 11, 2017

View reviewed changes

bpedersen2 force-pushed the hiddenfolders branch 2 times, most recently from 700c81a to 46bb658 Compare December 12, 2017 08:13

ThiefMaster requested changes Dec 12, 2017

View reviewed changes

bpedersen2 force-pushed the hiddenfolders branch from 46bb658 to d159639 Compare December 12, 2017 11:44

ThiefMaster changed the base branch from v2.1-dev to master January 12, 2018 14:58

bpedersen2 force-pushed the hiddenfolders branch from d159639 to b984a98 Compare January 29, 2018 07:43

bpedersen2 force-pushed the hiddenfolders branch from b984a98 to 1106aad Compare January 29, 2018 12:56

ThiefMaster reviewed Feb 12, 2018

View reviewed changes

bpedersen2 and others added 3 commits February 12, 2018 13:15

Add folder visibility indicator for attachments

b114984

If in management mode, indicate forced visibiliy/invisibility using an (striked-out) eye-icon.

Add changelog entry for hidden folders

db3666f

ThiefMaster force-pushed the hiddenfolders branch from 1106aad to db3666f Compare February 12, 2018 12:19

ThiefMaster approved these changes Feb 12, 2018

View reviewed changes

Improve wording

887cab8

ThiefMaster merged commit 9341a90 into indico:master Feb 12, 2018

bpedersen2 deleted the hiddenfolders branch February 13, 2018 07:12

		'NOT (is_hidden AND is_always_visible)', schema='attachments')


		def validate_is_always_visible(self, field):

Add support for hidden attachment folders #3181

Add support for hidden attachment folders #3181

Conversation

bpedersen2 commented Dec 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mic4ael commented Dec 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ThiefMaster Dec 12, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bpedersen2 commented Jan 29, 2018

Choose a reason for hiding this comment

ThiefMaster Dec 12, 2017 •

edited