Improve alt text handling (#815)

Also updates to support staging server deployment.

Author: bradchoate

.github/workflows/test-deploy.yml

@@ -4,7 +4,7 @@ env:
     build_number: ${{ github.run_id }}
 
 concurrency:
-    group: production
+    group: test-deploy
     cancel-in-progress: true
 
 on:
@@ -92,6 +92,24 @@ jobs:
                   docker compose -f release/docker-compose.yml down
                   docker container prune -f
 
+    staging:
+      needs: [test]
+      runs-on: ubuntu-latest
+      environment: staging
+      if: success()
+      steps:
+          - name: Login to Docker Hub
+            uses: docker/login-action@v3
+            with:
+                username: ${{ vars.DOCKERHUB_USERNAME }}
+                password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+          - name: Pull and tag web image
+            run: |
+                docker pull mltshp/mltshp-web:build-${{ env.build_number }}
+                docker tag mltshp/mltshp-web:build-${{ env.build_number }} mltshp/mltshp-web:staging
+                docker push mltshp/mltshp-web:staging
+
     deploy:
         needs: [test, build-worker]
         runs-on: ubuntu-latest

handlers/base.py

@@ -47,6 +47,12 @@ def finish(self, chunk=None):
         self.set_header('x-proc-time',"%s" % (proc_time))
         super(BaseHandler, self).finish(chunk)
 
+    def static_url(self, *args, **kwargs):
+        base_url = ""
+        if options.use_cdn:
+            base_url = "https://%s" % options.cdn_host
+        return base_url + super(BaseHandler, self).static_url(*args, **kwargs)
+
     def get_current_user(self):
         sid = self.get_secure_cookie(SESSION_COOKIE)
         if sid:
@@ -68,6 +74,7 @@ def render_string(self, template_name, **kwargs):
         current_user_object = self.get_current_user_object()
         kwargs['errors'] = self._errors
         kwargs['settings'] = self.settings
+        kwargs['host_banner'] = options.host_banner
         kwargs['app_host'] = options.app_host or self.request.host
         kwargs['app_scheme'] = (options.use_cdn and options.cdn_host and "https") or "http"
         kwargs['cdn_host'] = options.cdn_host

mltshpoptions.py

@@ -30,6 +30,7 @@ def parse_dictionary(settings):
 define('best_of_user_name', default='mltshp', help="User name where Best Of images are saved.")
 define('superuser_list', default='', help='Comma separated list of users who are superuser accounts')
 define('moderator_list', default='', help='Comma separated list of users who are moderator accounts')
+define('host_banner', default='', help='Shown in header when present')
 
 # infrastructure
 define('database_host', metavar="HOST", help="Hostname for database connection")

models/sharedfile.py

@@ -97,13 +97,14 @@ def get_alt_text(self, raw=False):
         for rendering alt text inside textarea fields.
         """
         alt_text = self.alt_text
-        if not alt_text:
+        if alt_text is None:
             alt_text = ''
 
         if not raw:
+            alt_text = escape.xhtml_escape(alt_text)
             alt_text = alt_text.replace('\n', '<br>')
 
-        return alt_text
+        return alt_text.strip()
 
     def save(self, *args, **kwargs):
         """
@@ -614,11 +615,12 @@ def thumbnail_url(self):
         if sourcefile.type == 'image':
             if self.original_id > 0:
                 original = self.original()
-                size = original.size
+                if original:
+                    size = original.size
             else:
                 size = self.size
         # Fastly I/O won't process images > 50mb, so condition for that
-        if sourcefile.type == 'image' and options.use_fastly and size < 50_000_000:
+        if sourcefile.type == 'image' and options.use_fastly and size > 0 and size < 50_000_000:
             return f"https://{options.cdn_host}/r/{self.share_key}?width=100"
         else:
             return s3_url(options.aws_key, options.aws_secret, options.aws_bucket, \
@@ -633,11 +635,11 @@ def small_thumbnail_url(self):
         if sourcefile.type == 'image':
             if self.original_id > 0:
                 original = self.original()
-                size = original.size
+                if original: size = original.size
             else:
                 size = self.size
         # Fastly I/O won't process images > 50mb, so condition for that
-        if sourcefile.type == 'image' and options.use_fastly and size < 50_000_000:
+        if sourcefile.type == 'image' and options.use_fastly and size > 0 and size < 50_000_000:
             return f"https://{options.cdn_host}/r/{self.share_key}?width=240&height=184&fit=bounds"
         else:
             return s3_url(options.aws_key, options.aws_secret, options.aws_bucket, \

setup/production/nginx.conf

@@ -70,7 +70,7 @@ http {
 
     server {
         listen 80;
-        server_name mltshp.com www.mltshp.com s.mltshp.com mltshp-cdn.com;
+        server_name mltshp.com www.mltshp.com s.mltshp.com mltshp-cdn.com stage.mltshp.com s.stage.mltshp.com stage.mltshp-cdn.com;
 
         # Allow file uploads
         client_max_body_size 30M;
@@ -82,13 +82,17 @@ http {
            # Main domain shouldn't be serving /s3, mltshp-cdn.com should
            rewrite  ^/s3/(.*)$  https://mltshp-cdn.com/s3/$1  permanent;
         }
+        if ($host = 'stage.mltshp.com' ) {
+           # Main domain shouldn't be serving /s3, mltshp-cdn.com should
+           rewrite  ^/s3/(.*)$  https://stage.mltshp-cdn.com/s3/$1  permanent;
+        }
 
         # Serve a static error page in case the app is offline
         error_page  502 503 504  /static/50x.html;
 
         location = /r/([a-zA-Z0-9\.]+) {
             proxy_pass_header Surrogate-Control;
-            valid_referers none blocked www.mltshp.com mltshp.com;
+            valid_referers none blocked www.mltshp.com mltshp.com stage.mltshp.com;
             if ($invalid_referer) {
                 return 403;
             }

templates/base.html

@@ -9,8 +9,8 @@
 
     <link type="text/css" rel="stylesheet" href="{{ static_url("css/main.min.css") }}">
 
-    <link rel="dns-prefetch" href="//s.mltshp.com">
-    <link rel="dns-prefetch" href="//mltshp-cdn.com">
+    <link rel="dns-prefetch" href="//s.{{ app_host }}">{% if cdn_host %}
+    <link rel="dns-prefetch" href="//{{ cdn_host }}">{% end %}
 
     <!-- Behave more like an app when saved to home screen in iOS -->
     <meta name="mobile-web-app-capable" content="yes">
@@ -132,6 +132,11 @@
                                     We’re doing something cool with the database!
                                 </li>
                             {% end %}
+                            {% if host_banner %}
+                                <li class="user-nav--item">
+                                    {{ escape(host_banner) }}
+                                </li>
+                            {% end %}
                             {% if current_user_object and not current_user_object.email_confirmed %}
                                 {% if not site_is_readonly %}
                                     <li class="user-nav--item">
@@ -150,6 +155,11 @@
                             </li>
                         {% else %}
                             {% set handler_class = handler.__class__.__name__  %}
+                            {% if host_banner %}
+                                <li class="user-nav--item">
+                                    {{ escape(host_banner) }}
+                                </li>
+                            {% end %}
                             <li class="user-nav--item">
                                 <a href="/sign-in?next={{request.path}}" class="user-nav--link">sign in</a>
                             </li>

templates/uimodules/image.html

@@ -98,10 +98,10 @@ <h1>{{escape(sharedfile.get_title())}}</h1>
         {% end %}
     </div>
     <div id="image-content-footer-{{sharedfile.share_key}}" class="image-content-footer">
-        <div class="alt-text {% if can_edit %}alt-text-edit{%end%}{% if not sharedfile.get_alt_text() %} alt-text--blank{%else%} alt-text--hidden{%end%}">
+        <div class="alt-text {% if can_edit %}alt-text-edit{%end%}{% if sharedfile.get_alt_text() == "" %} alt-text--blank{%else%} alt-text--hidden{%end%}">
             <div class="alt-text-toggle link link--primary">alt text</div>
             {% if can_edit and not site_is_readonly %}
-                {% if not sharedfile.get_alt_text() %}
+                {% if sharedfile.get_alt_text() == "" %}
                     <div class="the-alt-text" role="button">add some alt text</div>
                 {% else %}
                     <div class="the-alt-text" role="button">{{sharedfile.get_alt_text()}}</div>
@@ -120,7 +120,7 @@ <h3>Edit alt text</h3>
                     </div>
                 </form>
             {% else %}
-                {% if sharedfile.get_alt_text() %}
+                {% if sharedfile.get_alt_text() != "" %}
                     <div class="the-alt-text">{{sharedfile.get_alt_text()}}</div>
                 {% end %}
             {% end %}