feat: CMD-187 autocreate search page

README.md

@@ -207,6 +207,7 @@ To contribute, first read [How to Contribute][Contributing].
 | `python manage.py collectstatic` | [django](https://docs.djangoproject.com/en/3.2/howto/static-files/)
 | `python manage.py createsuperuser` | [django cms](https://docs.django-cms.org/en/release-3.8.x/how_to/install.html#admin-user), [django](https://docs.djangoproject.com/en/3.2/ref/django-admin/#createsuperuser)
 
+
 <!-- Link Aliases -->
 
 [Camino]: https://github.com/TACC/Camino

apps/search_page/apps.py

@@ -0,0 +1,10 @@
+from django.apps import AppConfig
+from django.conf import settings
+
+class SearchPageConfig(AppConfig):
+    name = 'apps.search_page'
+
+    def ready(self):
+        if settings.SEARCH_PAGE_AUTO_SETUP:
+            from .utils import create_page
+            create_page()

apps/search_page/cms_apps.py

@@ -0,0 +1,11 @@
+from cms.app_base import CMSApp
+from cms.apphook_pool import apphook_pool
+
+
+@apphook_pool.register
+class SearchPageApphook(CMSApp):
+    app_name = 'apps.search_page'
+    name = 'SearchPage'
+
+    def get_urls(self, page=None, language=None, **kwargs):
+        return ['apps.search_page.urls']

apps/search_page/static/search_page/css/google-search.css

@@ -0,0 +1,152 @@
+#google-search {
+
+  &:is(#cms-content-container > *:last-child) {
+    margin-bottom: var(--global-space--section-gap, 60px);
+  }
+
+  /* SEARCH CONTAINER */
+
+  /* To remove padding from search container */
+  & .gsc-control-cse {
+    padding: unset;
+  }
+
+
+
+  /* TABLE OF SEARCH STATS & SORTING OPTIONS */
+
+  /* To remove border from search analytics, add gray background */
+  & .gsc-above-wrapper-area {
+    --bkgd-color: var(--global-color-primary--x-light);
+
+    background-color: var(--bkgd-color);
+    box-shadow: 40vw 0 var(--bkgd-color), -40vw 0 var(--bkgd-color);
+    border-bottom: unset;
+  }
+
+  & .gsc-above-wrapper-area-container {
+    border-bottom: unset;
+  }
+
+  /* To override Core-Styles tables */
+  & tbody > tr:first-child > :is(td, th) {
+    border: unset;
+    padding-inline: unset;
+    background: unset;
+    vertical-align: middle;
+  }
+
+  & .gsc-selected-option-container {
+    background: var(--global-color-primary--xx-light);
+    border: var(--global-border--normal);
+  }
+
+  & .gsc-result-info {
+    padding: unset;
+    font-size: var(--global-font-size--medium);
+  }
+
+
+
+  /* SUGGESTION PHRASE (after "Did you mean:") */
+
+  & .gs-spelling {
+    padding: unset;
+  }
+  & .gs-spelling a {
+    color: var(--global-color-accent--light);
+
+    /* to undo core-styles.base */
+    /* https://github.com/TACC/Core-Styles/blob/8ab89d3/src/lib/_imports/elements/links.css */
+    &:not([href]) {
+      opacity: 1;
+      pointer-events: auto;
+    }
+  }
+
+
+
+  /* SEARCH RESULTS */
+
+  /* (search result body text) */
+  & .gs-snippet {
+    color: var(--global-color-primary--dark);
+  }
+
+  /* (url under search result title) */
+  & .gs-webResult div.gs-visibleUrl {
+    color: var(--global-color-secondary--normal);
+  }
+
+  /* (search result titles) */
+  & a.gs-title:link {
+    color: var(--global-color-accent--light);
+    text-decoration: none;
+    text-decoration-thickness: var(--global-border-width--normal);
+    text-underline-offset: 0.2em;
+  }
+  & a.gs-title:link:hover {
+    text-decoration-line: underline;
+    text-decoration-style: solid;
+  }
+  & a.gs-title b {
+    color: currentColor;
+  }
+  & .gs-result .gs-title:not(a):hover {
+    /* to remove duplicate underline */
+    /* (fix Google's default_v6+en.css bug `.gs-result .gs-title:hover`) */
+    text-decoration: auto;
+  }
+
+  /* (push search-result description to right) */
+  & .gs-image-box {
+    margin-right: 10px;
+  }
+
+
+
+  /* GOOGLE PAGE NAVIGATION (at bottom) */
+
+  & .gsc-cursor-box {
+    display: flex;
+    justify-content: center;
+    margin-block: var(--global-space--large);
+  }
+
+  & .gsc-cursor-current-page {
+    color: var(--global-color-accent--light);
+    text-decoration: none;
+    text-decoration-thickness: var(--global-border-width--normal);
+    text-underline-offset: 0.2em;
+  }
+
+  & .gsc-cursor-current-page:hover {
+    text-decoration-line: underline;
+    text-decoration-style: solid;
+  }
+
+
+
+  /* GOOGLE BRANDING */
+
+  & .gcsc-find-more-on-google {
+    color: var(--global-color-accent--light);
+    text-decoration: none;
+    text-decoration-thickness: var(--global-border-width--normal);
+    text-underline-offset: 0.2em;
+  }
+  svg.gcsc-find-more-on-google-magnifier {
+    fill: currentColor;
+  }
+
+  & .gcsc-find-more-on-google:hover {
+    text-decoration-line: underline;
+    text-decoration-style: solid;
+  }
+
+  & .gcsc-branding-img-noclear {
+    vertical-align: unset;
+    top: 1px;
+  }
+
+}

apps/search_page/templates/search_page.html

@@ -0,0 +1,25 @@
+{% extends "base.html" %}
+{% load static cms_tags %}
+
+{% block css %}
+  {{ block.super }}
+  <link id="css-search" rel="stylesheet" href="{% static 'search_page/css/google-search.css' %}">
+{% endblock css %}
+
+{% block app_content %}
+  <div class="row">
+    <div class="col col-12 col-sm-12 col-md-6 col-lg-6 col-xl-6">
+      <h1>{% page_attribute "page_title" %}</h1>
+    </div>
+  </div>
+
+  {% if settings.GOOGLE_SEARCH_ENGINE_ID %}
+  <div id="google-search">
+    <script async src="https://cse.google.com/cse.js?cx={{ settings.GOOGLE_SEARCH_ENGINE_ID }}">
+    </script>
+    <div class="gcse-searchresults-only"></div>
+  </div>
+  {% else %}
+    <p class="c-message c-message--scope-section c-message--type-warning">Please inform your website administrator to verify a <code>GOOGLE_SEARCH_ENGINE_ID</code> is set for this website.</p>
+  {% endif %}
+{% endblock app_content %}

apps/search_page/urls.py

@@ -0,0 +1,8 @@
+from django.urls import path
+from . import views
+
+app_name = 'apps.search_page'
+
+urlpatterns = [
+    path('', views.SearchPageView, name='search'),
+]

apps/search_page/utils.py

@@ -0,0 +1,64 @@
+import logging
+
+from django.conf import settings
+from django.urls import reverse, NoReverseMatch
+
+from cms.api import create_page as create_cms_page
+from cms.models.pagemodel import Page
+
+from .cms_apps import SearchPageApphook
+
+
+logger = logging.getLogger(f'portal.{__name__}')
+
+TITLE = 'Search'
+REVERSE_ID = 'search_page'
+DEFAULT_SLUG = settings.PORTAL_SEARCH_PATH.strip('/')
+
+def get_page():
+    try:
+        return Page.objects.filter(reverse_id=REVERSE_ID).first()
+    except Page.DoesNotExist:
+        return None
+
+def get_slug(page=None):
+    if page:
+        return page.get_slug()
+    else:
+        page = get_page()
+        return get_slug(page) if page else DEFAULT_SLUG
+
+def get_page_url():
+    page = get_page()
+    if page:
+        return page.get_absolute_url()
+    else:
+        try:
+            return reverse('apps.search_page:search')
+        except NoReverseMatch:
+            return None
+
+def create_page():
+    page = get_page()
+    slug = get_slug(page)
+
+    if not page:
+        page = create_cms_page(
+            title=f'{TITLE} (Auto-Generated)',
+            menu_title=TITLE,
+            page_title=TITLE,
+            reverse_id=REVERSE_ID,
+            # Use a template from CMS_TEMPLATES setting
+            template='standard.html',
+            language='en',
+            published=True,
+            slug=slug,
+            in_navigation=False,
+            apphook=SearchPageApphook,
+            apphook_namespace=SearchPageApphook.name,
+        )
+        logger.info(f'Created search page "{TITLE}" at "{slug}"')
+    else:
+        logger.info(f'Found existing search page at "{slug}"')
+
+    return page

apps/search_page/views.py

@@ -0,0 +1,4 @@
+from django.shortcuts import render
+
+def SearchPageView(request):
+    return render(request, 'search_page.html')

pyproject.toml

@@ -45,9 +45,7 @@ djangocms-admin-style = "~3.2.6"
 djangocms-apphook-setup = "0.4.1"
 djangocms-attributes-field = "2.1.0"
 djangocms-blog = "2.0.3"
-# TO get a commit in main (since v3.0.1) to fix Container error
-# https://github.com/django-cms/djangocms-bootstrap4/pull/164
-djangocms-bootstrap4 = {git = "https://github.com/django-cms/djangocms-bootstrap4.git", rev = "49983f4"}
+djangocms-bootstrap4 = "^3.0"
 djangocms-column = "^2.0"
 djangocms-file = "3.0.0"
 djangocms-forms-maintained = { git = "https://github.com/TACC/djangocms-forms", rev = "6b59ff366495915f06f4d6fac01a2f0aa9efecaf" }

taccsite_cms/_settings/djangocms_plugins.py

@@ -38,7 +38,9 @@
     ('center', _('Align center')),
 ]
 DJANGOCMS_PICTURE_TEMPLATES = [
-    ('no_link_to_ext_image', _('Do not link to external image')),
+    ('no_link_to_ext_image', _('Do not link to "External image"')),
+    ('zoom_effect', _('Zoom image on hover')),
+    ('zoom_effect_no_link_to_ext_image', _('Zoom image on hover & Do not link to "External image"')),
 ]
 
 ########################

taccsite_cms/_settings/search.py

@@ -5,16 +5,19 @@
 ########################
 
 # To support any search
-PORTAL_SEARCH_PATH = '/search'
+PORTAL_SEARCH_PATH = '/search/'
 
 # To support Google search
 # PORTAL_SEARCH_QUERY_PARAM_NAME = 'q'
 # PORTAL_SEARCH_INDEX_IS_AUTOMATIC = False
+GOOGLE_SEARCH_ENGINE_ID = ''
 
 # (DEPRECATED) To support Elasticsearch
 PORTAL_SEARCH_QUERY_PARAM_NAME = 'query_string'
 PORTAL_SEARCH_INDEX_IS_AUTOMATIC = True
 
+SEARCH_PAGE_AUTO_SETUP = True
+
 ES_AUTH = 'username:password'
 ES_HOSTS = 'http://elasticsearch:9200'
 ES_INDEX_PREFIX = 'cms-dev-{}'
@@ -34,5 +37,6 @@
 ALDRYN_SEARCH_REGISTER_APPHOOK = True
 
 _INSTALLED_APPS = [
-    'haystack',                # search index
+    'haystack',                # ElasticSearch
+#    'search_page'              # Google Search
 ]

taccsite_cms/apps.py

@@ -1,7 +1,9 @@
 import logging
+
 from django.apps import AppConfig
 from django.db.models.signals import post_migrate
 
+from .djangocms_picture.extend import extendPicturePlugin
 from .djangocms_bootstrap4.contrib.bootstrap4_link.extend import extendBootstrap4LinkPlugin
 from .djangocms_blog.extend import extendBlogFeaturedPostsPlugin, extendBlogFeaturedPostsPluginCached
 from .djangocms_blog.patch import patchBlog
@@ -14,6 +16,7 @@ class TaccsiteCmsConfig(AppConfig):
 
     def ready(self):
         post_migrate.connect(self.create_groups, sender=self)
+        extendPicturePlugin()
         extendBootstrap4LinkPlugin()
         extendBlogFeaturedPostsPlugin()
         extendBlogFeaturedPostsPluginCached()