feat: TV3-181 allow remote LOGO and FAVICON

[wesleyboar]

Overview

• Allow adding remote URLs for logo and favicon.
• Support TACC_LOGO and TACC_FAVICON.
• Deprecate LOGO and FAVICON.

Related

• TV3-181
• required by feat: TV3-181 add ptdatax Core-CMS-Custom#257
• expected by feat: TV3-181 add ptatax_assets Core-CMS-Custom#260
• introduces CMD-79: Prefix CMS Settings w/ CORE_CMS_ not TACC_

Changes

• added is_remote boolean for FAVICON settings
• added simple protocol parse logic for LOGO filename
• added non-static asset load for LOGO and FAVICON settings

Testing

1. Load Core-CMS sans taccsite_cms/settings_custom.py.
2. Verify logo is default — white "PORTAL".
3. Verify favicon is default — white star on blue field.
4. Load Core-CMS with taccsite_cms/settings_custom.py.
   _{cp taccsite_cms/settings_custom.example.py taccsite_cms/settings_custom.py}
5. Restart server.
6. Verify logo is PTDataX's — "DATAX".
7. Verify favicon is PTDataX's — multi-colored "X".
8. Edit taccsite_cms/settings.py, uncomment LOGO setting.
9. Edit taccsite_cms/settings.py, uncomment FAVICON setting.
10. Restart server (if necessary).
11. Verify logo is default — white "PORTAL".
12. Verify favicon is default — white star on blue field.
13. Re-test feat: TV3-181 add ptatax_assets Core-CMS-Custom#260.

UI

Standard	Custom	Deprecated

Notes

Used on client via TACC/Core-CMS-Custom#260.

[rstijerina]

Would you be able to make this change for Core-Portal as well?

[wesleyboar]

Yes, but I'm worried about doing it without answering questions first:

1. Why does Portal use {% static %} as '/core/static/'?
2. Would it be confusing or clearer for CMS and Portal to have the same STATIC_URL = '/static/' setting?
3. Should Core-Portal refactor to, like TUP, use only one Django instance?

I am still recovering from flu, so apologies if I am dense.

[rstijerina]

1 and 2: There is the risk of file collision if both portal and cms use the same static directory. Likelihood does seem low. Is there an advantage to both using the same static url?
3: Can you expand on this? I'm not sure what you're referring to exactly

[wesleyboar]

1. & 2. I can't think of one.
3. Unrelated topic I was forcing into the conversation through logic I did not expose. Please never mind for this topic.

Yes, I can do it.

On Portal, would the value /static/... (to load from Core-CMS) use is_remote = TRUE, because it's not using Core-Portal's {% static %}?

[rstijerina]

On Portal, would the value /static/... (to load from Core-CMS) use is_remote = TRUE, because it's not using Core-Portal's {% static %}?

Ah I see, the portal already kinda handles this in that it doesn't default to using % static %. Think it's still needed?

[wesleyboar]

I forgot about this. Back now. And reading it without the flu fogging my brain.

I think Portal does not need {% static %} option for favicon. It works for remote and CMS assets with its code as is. To update Portal would be for consistency. A welcome change, but a rabbit hole. The divergence occurred and is great now.

Details (for those who didn't read the thread)

Adding {% static %} and is_remote option to Portal adds complexity. The Portal already assumes favicon is not a "local" asset, thus assumes it will be given a non-Portal-static-asset URL. If existing hardcoded /static/ values concern us, we can add something like CMS_STATIC_DIR in default settings.

https://github.com/TACC/Core-Portal/blob/v3.5.0/server/portal/templates/base.html#L11-L13

    {% if settings.PORTAL_ICON_FILENAME %}
    <link rel="icon" href="{{ settings.PORTAL_ICON_FILENAME }}">
    {% else %}

[wesleyboar]

@taoteg will test this theory on DigitalRocks. 😀

[wesleyboar]

I will return with a PR that supports prefixes TACC_ and CORE_CMS_ (and/or something else we decide) [supports PORTAL_ prefix], so that the confusing TACC_LOGO and TACC_FAVICON do not propagate.

[wesleyboar]

See CMD-79 next.