Merge pull request #732 from DougReeder/default-site-name

Assembles informative & polished metadata from whatever values are available

Author: Exairnous

lib/ret/http_utils.ex

@@ -175,4 +175,20 @@ defmodule Ret.HttpUtils do
   defp module_config(key) do
     Application.get_env(:ret, __MODULE__)[key]
   end
+
+  def join_smart(enum) do
+    Enum.reduce(enum, "", fn(x, acc) ->
+      x = cond do
+        !x -> nil
+        is_binary(x) -> String.trim(x)
+        true -> "#{x}"
+      end
+      if x && x != "" do
+        if acc && acc != "", do: acc <> " — " <> x, else: x
+      else
+        acc
+      end
+    end)
+  end
+
 end

lib/ret_web/controllers/file_controller.ex

@@ -26,8 +26,8 @@ defmodule RetWeb.FileController do
 
         app_name =
           AppConfig.get_cached_config_value("translations|en|app-full-name") ||
-            AppConfig.get_cached_config_value("translations|en|app-name")
-        title = "Photo taken in #{app_name} immersive space, powered by Hubs"
+            AppConfig.get_cached_config_value("translations|en|app-name") || RetWeb.Endpoint.host()
+        title = "Photo taken in #{app_name} immersive space"
         config = AppConfig.get_config()
 
         conn
@@ -36,7 +36,11 @@ defmodule RetWeb.FileController do
           content_type: content_type |> RetWeb.ContentType.sanitize_content_type(),
           content_length: content_length,
           title: title,
+          description_social_media: Ret.HttpUtils.join_smart([
+            config["translations"]["en"]["app-tagline"],
+            "powered by Hubs"]),
           translations: config["translations"]["en"],
+          app_name: app_name,
           images: config["images"],
           root_url: RetWeb.Endpoint.url()
         )

lib/ret_web/controllers/page_controller.ex

@@ -17,6 +17,7 @@ defmodule RetWeb.PageController do
 
   alias Plug.Conn
   import Ret.ConnUtils
+  import Ret.HttpUtils
 
   ##
   # NOTE: In addition to adding a route, you must add static html pages to the page_origin_warmer.ex
@@ -63,12 +64,19 @@ defmodule RetWeb.PageController do
   defp render_scene_content(%t{} = scene, conn) when t in [Scene, SceneListing] do
     {app_config, app_config_script} = generate_app_config()
 
+    app_name = app_config["translations"]["en"]["app-full-name"] || app_config["translations"]["en"]["app-name"] || RetWeb.Endpoint.host()
     scene_meta_tags =
       Phoenix.View.render_to_string(RetWeb.PageView, "scene-meta.html",
         scene: scene,
         ret_meta: Ret.Meta.get_meta(include_repo: false),
         translations: app_config["translations"]["en"],
-        description: "A scene you can use in the #{app_config["translations"]["en"]["app-name"] || ''} immersive spaces and others powered by Hubs. #{app_config["translations"]["en"]["app-description"] || ''}" |> String.replace("\\n", " "),
+        title: join_smart([ scene.name, app_name ]),
+        name: scene.name,
+        description: join_smart([
+          scene.description,
+          "A scene you can use in the #{app_name} immersive spaces and others powered by Hubs",
+          app_config["translations"]["en"]["app-description"]
+        ]) |> String.replace("\\n", " "),
         app_config_script: {:safe, app_config_script |> with_script_tags},
         extra_script: {:safe, get_extra_script(:scene) |> with_script_tags},
         extra_html: {:safe, get_extra_html(:scene) || ""}
@@ -97,10 +105,13 @@ defmodule RetWeb.PageController do
   defp render_avatar_content(%t{} = avatar, conn) when t in [Avatar, AvatarListing] do
     {app_config, app_config_script} = generate_app_config()
 
+    app_name = app_config["translations"]["en"]["app-full-name"] || app_config["translations"]["en"]["app-name"] || RetWeb.Endpoint.host()
     avatar_meta_tags =
       Phoenix.View.render_to_string(RetWeb.PageView, "avatar-meta.html",
         avatar: avatar,
-        description: "An avatar you can use in the #{app_config["translations"]["en"]["app-name"] || ""} immersive spaces and others powered by Hubs." |> String.replace("\\n", " "),
+        title: join_smart([avatar.name, app_name]),
+        name: avatar.name,
+        description: "An avatar you can use in the #{app_name} immersive spaces and others powered by Hubs.",
         ret_meta: Ret.Meta.get_meta(include_repo: false),
         translations: app_config["translations"]["en"],
         root_url: RetWeb.Endpoint.url(),
@@ -132,13 +143,20 @@ defmodule RetWeb.PageController do
   defp render_homepage_content(conn, nil = _public_room_id) do
     {app_config, app_config_script} = generate_app_config()
 
+    app_name = app_config["translations"]["en"]["app-full-name"] || app_config["translations"]["en"]["app-name"] || RetWeb.Endpoint.host()
+
     index_meta_tags =
       Phoenix.View.render_to_string(
         RetWeb.PageView,
         "index-meta.html",
         root_url: RetWeb.Endpoint.url(),
         translations: app_config["translations"]["en"],
-        description: "#{app_config["translations"]["en"]["app-description"] || ''} — Immersive spaces, right in your browser, powered by Hubs" |> String.replace("\\n", " "),
+        app_name: app_name,
+        title: join_smart([app_name, app_config["translations"]["en"]["app-tagline"]]),
+        description: join_smart(
+          [app_config["translations"]["en"]["app-description"],
+          "Immersive spaces, right in your browser, powered by Hubs"
+        ]),
         images: app_config["images"],
         app_config_script: {:safe, app_config_script |> with_script_tags},
         extra_script: {:safe, get_extra_script(:index) |> with_script_tags},
@@ -272,10 +290,11 @@ defmodule RetWeb.PageController do
             manifest =
               Phoenix.View.render_to_string(RetWeb.PageView, "manifest.webmanifest",
                 root_url: RetWeb.Endpoint.url(),
-                app_name: get_app_config_value("translations|en|app-name") || "",
-                app_description:
-                  (get_app_config_value("translations|en|app-description") || "")
-                  |> String.replace("\\n", " ")
+                app_name: get_app_config_value("translations|en|app-name") || RetWeb.Endpoint.host(),
+                app_description: join_smart([
+                  get_app_config_value("translations|en|app-description"),
+                  "Immersive spaces, right in your browser, powered by Hubs"
+                ]) |> String.replace("\\n", " ")
               )
 
             unless module_config(:skip_cache) do
@@ -394,7 +413,7 @@ defmodule RetWeb.PageController do
     |> put_resp_header(
       "hub-name",
       get_app_config_value("translations|en|app-full-name") ||
-        get_app_config_value("translations|en|app-name") || ""
+        get_app_config_value("translations|en|app-name") || RetWeb.Endpoint.host()
     )
     |> put_resp_header(
       "hub-entity-type",
@@ -462,14 +481,35 @@ defmodule RetWeb.PageController do
     {_, available_integrations_script} =
       Ret.Meta.available_integrations_meta() |> generate_config("AVAILABLE_INTEGRATIONS")
 
+    app_name = app_config["translations"]["en"]["app-name"] || RetWeb.Endpoint.host()
+    scene = hub.scene || hub.scene_listing
+    name = cond do
+      hub.name && scene && scene.name && scene.name != hub.name -> join_smart([hub.name, scene.name])
+      hub.name -> hub.name
+      scene && scene.name -> scene.name
+      true -> "a room on " <> app_name
+    end
     hub_meta_tags =
       Phoenix.View.render_to_string(RetWeb.PageView, "hub-meta.html",
         hub: hub,
-        scene: hub.scene,
+        scene: scene,
         ret_meta: Ret.Meta.get_meta(include_repo: false),
         available_integrations_script: {:safe, available_integrations_script |> with_script_tags},
         translations: app_config["translations"]["en"],
-        description: "Join others in an immersive space in #{app_config["translations"]["en"]["app-name"] || ''}, right in your browser. #{app_config["translations"]["en"]["app-description"] || ''} — Powered by Hubs." |> String.replace("\\n", " "),
+        title: join_smart([hub.name, app_name]),
+        name: name,
+        description: join_smart([
+          hub.description,
+          "an immersive space in #{app_name}, right in your browser",
+          app_config["translations"]["en"]["app-description"],
+          "powered by Hubs."
+        ]) |> String.replace("\\n", " "),
+        description_social_media: join_smart([
+          "Join others in an immersive space in #{app_name}, right in your browser",
+          hub.description,
+          app_config["translations"]["en"]["app-description"],
+          "powered by Hubs."
+        ]) |> String.replace("\\n", " "),
         app_config_script: {:safe, app_config_script |> with_script_tags},
         extra_script: {:safe, get_extra_script(:room) |> with_script_tags},
         extra_html: {:safe, get_extra_html(:room) || ""}

lib/ret_web/email.ex

@@ -3,7 +3,7 @@ defmodule RetWeb.Email do
   alias Ret.{AppConfig}
 
   def auth_email(to_address, signin_args) do
-    app_name = AppConfig.get_cached_config_value("translations|en|app-name")
+    app_name = AppConfig.get_cached_config_value("translations|en|app-name") || RetWeb.Endpoint.host()
     app_full_name = AppConfig.get_cached_config_value("translations|en|app-full-name") || app_name
     admin_email = Application.get_env(:ret, Ret.Account)[:admin_email]
     custom_login_subject = AppConfig.get_cached_config_value("auth|login_subject")

lib/ret_web/templates/file/show.html.eex

@@ -13,30 +13,34 @@
         "contentUrl": "<%= @image_url %>",
         "encodingFormat": "<%= @content_type %>",
         "contentSize": "<%= @content_length %> b",
-        "keywords": ["screenshot", "Hubs", "immersive 3D spaces", "social VR", "<%= @translations["share-hashtag"] %>"],
+        "keywords": ["screenshot", "Hubs", "immersive 3D spaces", "social VR", "<%= @translations["share-hashtag"] %>", "<%= @translations["company-name"] %>"],
+        <%= if @translations["company-name"] || @translations["contact-email"] do %>
         "maintainer": {
             "@type": "Organization",
-            "name": "<%= @translations["company-name"] %>",
+            "name": "<%= @translations["company-name"] || @app_name %>",
             "email": "<%= @translations["contact-email"] %>",
             "logo": "<%= @images["company_logo"] %>"
         },
+        <% end %>
         "isBasedOn": "<%= @root_url %>/",
-        "creditText": "check with <%= @translations["company-name"] %>"
+        "creditText": "check with <%= @translations["company-name"] || @app_name %>"
     }
     </script>
 
     <meta name="twitter:card" content="summary_large_image">
     <meta name="twitter:domain" value="<%= RetWeb.Endpoint.host %>" />
     <meta name="twitter:title" value="<%= @title %>" />
-    <meta name="twitter:description" content="<%= @title %>">
+    <meta name="twitter:description" content="<%= @description_social_media %>">
     <meta name="twitter:image" content="<%= @image_url %>"/>
     <meta name="twitter:url" value="<%= @image_url %>" />
 
     <meta property="og:type" content="website" />
     <meta property="og:url" content="<%= @image_url %>" />
     <meta property="og:title" content="<%= @title %>" />
-    <meta property="og:description" content="<%= @title %>">
+    <meta name="description" property="og:description" content="<%= @description_social_media %>">
     <meta property="og:image" content="<%= @image_url %>"/>
+    <meta property="og:image:type" content="<%= @content_type %>" />
+    <meta name="application-name" property="og:site_name" content="<%= @app_name %>" />
     <title><%= @title %></title>
     <style>
       body {
@@ -58,7 +62,7 @@
   </head>
   <body>
     <a href="<%= RetWeb.Endpoint.url %>">
-        <img src="<%= @image_url %>"/>
+        <img src="<%= @image_url %>" alt="<%= @title %>"/>
     </a>
   </body>
 </html>

lib/ret_web/templates/page/avatar-meta.html.eex

@@ -2,27 +2,27 @@
     {
         "@context": "https://schema.org/",
         "@type": "3DModel",
-        "name": "<%= @avatar.name %> | <%= @translations["app-full-name"] || @translations["app-name"] %>",
+        "name": "<%= @name %>",
         "url": "<%= @avatar |> Ret.Avatar.url %>",
         "contentUrl": "<%= @avatar.gltf_owned_file |> Ret.OwnedFile.uri_for |> URI.to_string %>",
         "thumbnailUrl": "<%= @avatar.thumbnail_owned_file |> Ret.OwnedFile.uri_for |> URI.to_string %>",
         "description": "<%= @description %>",
-        "isResizable": false,
+        "isResizable": true,
         "keywords": ["3D avatar", "Hubs", "immersive 3D spaces", "social VR", "<%= @translations["share-hashtag"] %>"],
         "isPartOf": "<%= @root_url %>/"
     }
 </script>
 
 <meta property="og:type" content="website" />
 <meta property="og:url" content="<%= @avatar |> Ret.Avatar.url %>" />
-<meta property="og:title" content="<%= @avatar.name %> | <%= @translations["app-full-name"] || @translations["app-name"] %>" />
-<meta property="og:description" content="<%= @description %>" />
+<meta property="og:title" content="<%= @name %>" />
+<meta name="description" property="og:description" content="<%= @description %>" />
 <meta property="og:image" content="<%= @avatar.thumbnail_owned_file |> Ret.OwnedFile.uri_for |> URI.to_string %>"/>
-<meta property="og:site_name" content="<%= @translations["app-full-name"] || @translations["app-name"] %>"/>
+<meta name="application-name" property="og:site_name" content="<%= @translations["app-full-name"] || @translations["app-name"] || RetWeb.Endpoint.host() %>"/>
 
 <meta name="twitter:card" content="summary_large_image">
 <meta name="twitter:domain" content="<%= RetWeb.Endpoint.host %>" />
-<meta name="twitter:title" content="<%= @avatar.name %> | <%= @translations["app-full-name"] || @translations["app-name"] %>" />
+<meta name="twitter:title" content="<%= @name %>" />
 <meta name="twitter:description" content="<%= @description %>" />
 <meta name="twitter:image" content="<%= @avatar.thumbnail_owned_file |> Ret.OwnedFile.uri_for |> URI.to_string %>"/>
 <meta name="twitter:url" content="<%= @avatar |> Ret.Avatar.url %>" />
@@ -32,8 +32,7 @@
 <meta name="ret:phx_port" value="<%= @ret_meta[:phx_port] %>" />
 <meta name="ret:pool" value="<%= @ret_meta[:pool] %>" />
 
-<title><%= @avatar.name %> | <%= @translations["app-full-name"] || @translations["app-name"] %></title>
-<meta name="description" content="<%= @description %>" />
+<title><%= @title %></title>
 
 <%= @app_config_script %>
 <%= @extra_html %>

lib/ret_web/templates/page/hub-meta.html.eex

@@ -4,30 +4,24 @@
     {
         "@context": "https://schema.org/",
         "@type": "VirtualLocation",
-        "name": "<%= @hub.name %> | <%= @translations["app-full-name"] || @translations["app-name"] || "" %>",
+        "name": "<%= @name %>",
         "url": "<%= @hub |> Ret.Hub.url_for %>",
         "image": "<%= @hub |> Ret.Hub.image_url_for %>",
-        "description": "<%= @description %>",
-        "disambiguatingDescription": "<%= @scene && @scene.name %>"
+        "description": "<%= @description %>"
     }
 </script>
 
 <meta property="og:type" content="website" />
 <meta property="og:url" content="<%= @hub |> Ret.Hub.url_for %>" />
-<meta property="og:title" content="<%= @hub.name %> | <%= @translations["app-full-name"] || @translations["app-name"] %>" />
-<meta property="og:description" content="<%= @description %>" />
+<meta property="og:title" content="<%= @name %>" />
+<meta name="description" property="og:description" content="<%= @description_social_media %>" />
 <meta property="og:image" content="<%= @hub |> Ret.Hub.image_url_for %>"/>
-<meta property="og:site_name" content="<%= @translations["app-full-name"] || @translations["app-name"] %>"/>
-
-<meta name="description" content="<%= @description %>" />
-
-<meta itemprop="name" content="<%= @hub.name %> | <%= @translations["app-full-name"] || @translations["app-name"] %>" />
-<meta itemprop="description" content="<%= @description %>" />
+<meta name="application-name" property="og:site_name" content="<%= @translations["app-full-name"] || @translations["app-name"] || RetWeb.Endpoint.host() %>"/>
 
 <meta name="twitter:card" content="summary_large_image">
 <meta name="twitter:domain" content="<%= RetWeb.Endpoint.host %>" />
-<meta name="twitter:title" content="<%= @hub.name %> | <%= @translations["app-full-name"] || @translations["app-name"] %>" />
-<meta name="twitter:description" content="<%= @description %>" />
+<meta name="twitter:title" content="<%= @name %>" />
+<meta name="twitter:description" content="<%= @description_social_media %>" />
 <meta name="twitter:image" content="<%= @hub |> Ret.Hub.image_url_for %>"/>
 <meta name="twitter:url" content="<%= @hub |> Ret.Hub.url_for %>" />
 
@@ -38,7 +32,7 @@
 
 <link rel="apple-touch-icon" href="/app-icon.png">
 
-<title><%= @hub.name %> | <%= @translations["app-full-name"] || @translations["app-name"] %></title>
+<title><%= @title %></title>
 
 <%= @available_integrations_script %>
 <%= @app_config_script %>

lib/ret_web/templates/page/hub.service-meta.js.eex

@@ -1 +1 @@
-appFullName = "<%= @translations["app-full-name"] || @translations["app-name"] %>";
+appFullName = "<%= @translations["app-full-name"] || @translations["app-name"] || RetWeb.Endpoint.host() %>";