1С-Битрикс Разработчикам - Композит и поддержка нескольких шаблонов

Композит и поддержка нескольких шаблонов

29 Март, 2019 12:11

Композит и поддержка нескольких шаблонов

Часто для мобильной версии делают отдельный шаблон и не используют при этом для мобильной версии отдельный поддомен. В результате получается, что по оному урлу могут отдаваться разные страницы, что делает невозможным включить композит на сайте.

Но всё же при определенных действиях, можно сделать корректным работу композита в таких случаях. Это потребует доработки, как со стороны сайта, так и со стороны nginx.

Суть решения - для мобильной версии всегда подставлять в request_urI определенный параметр, и устанавливать куку. Кука нужна, чтобы на стороне nginx можно было определить какую именно страницу отображать из кеша.

А теперь подробнее:

1) В htaccess добавляем php_value auto_prepend_file с пум на файл с таким содержимым:

if(isset($_GET['set_mobile'])) {
    if($_GET['set_mobile'] == 'Y') {
        setcookie('mobile', 'Y', time() + 7 * 24 * 60 * 60, '/', 'domain.ru');
    } else {
        setcookie('mobile', 'N', time() + 7 * 24 * 60 * 60, '/', 'domain.ru');
    }
    $uri = parse_url($_SERVER['REQUEST_URI']);
    parse_str($uri['query'], $params);
    unset($params['set_mobile']);
    $uri['query'] = http_build_query($params);
    header("Location: " . "https://" . $_SERVER['HTTP_HOST'] . $uri['path'].($uri['query'] ? '?'.$uri['query'] : '') );
    die();
}

$mobile = false;
if(!$_COOKIE['mobile']) {
    if (preg_match('/(android|avantgo|blackberry|bolt|boost|cricket|docomo|fone|hiptop|mini|mobi|palm|phone|pie|tablet|up\.browser|up\.link|webos|wos)/i', $_SERVER['HTTP_USER_AGENT'])) {
        setcookie('mobile', 'Y', time() + 7 * 24 * 60 * 60, '/', 'domain.ru');
        $mobile = true;
    } else {
        setcookie('mobile', 'N', time() + 7 * 24 * 60 * 60, '/', 'domain.ru');
        $mobile = false;
    }
} else {
    $mobile = $_COOKIE['mobile'] == 'Y' ? true : false;
}

if($mobile) {
    $uri = parse_url($_SERVER['REQUEST_URI']);
    $_SERVER['REQUEST_URI'] = $uri['path'].'?mobile=Y'.(isset($uri['query']) ? '&'.$uri['query'] : '');
}

Тут вызов страницы с параметром set_mobile=Y устанавливает куку mobile=Y и редиректит на ту же станицу, но без параметра set_mobile=Y. Аналогично set_mobile=N устанавливает куку mobile=N.
Если в момент загрузки страницы куки mobile не существует, то на основе user-agent определяем десктоп или мобильную версию.
Далее, основываясь на куке mobile, при необходимости, в request_uri добавляем параметр mobile=Y.

2) В настройках композита необходимо добавить параметр set_mobile в "Параметры URL, при которых не будет работать композитный режим".
Теперь при включении композита для основной и мобильной версии будет создаваться разный кеш.

Осталось настроить nginx. Для этого надо создать два файла конфигурации:

1) Для определения на основе user_agent и куки какую версию кеа отдавать. Если куки нету, то смотрим по user_agent, если кука есть, то смотрим на содержимое куки.
/etc/nginx/bx/maps/composite_ex.conf

map $http_user_agent $is_mobile {
    default "N";
    ~*android|avantgo|blackberry|bolt|boost|cricket|docomo|fone|hiptop|mini|mobi|palm|phone|pie|tablet|up\.browser|up\.link|webos|wos "Y";
} 

map "$cookie_mobile:$is_mobile:$is_args" $mobile {
  default         "";
  ":Y:?"          "mobile=Y&";
  ":Y:"           "mobile=Y";
  "Y:Y:?"         "mobile=Y&";
  "Y:Y:"          "mobile=Y";
  "N:Y:?"         "";
  "N:Y:"          "";
}

2) Чуть измененный конфиг, стандартного комозита.
/etc/nginx/bx/conf/composite_ex.conf

set $composite_cache    "bitrix/html_pages/${host}${composite_key}/index@${mobile}${args}.html";
set $composite_file     "${docroot}/${composite_cache}";
set $composite_enabled  "${docroot}/bitrix/html_pages/.enabled";
set $use_composite_cache "";
if ($is_global_composite  = 1) {set $use_composite_cache "A";}

include bx/conf/bitrix_general.conf;

location / {
   if (-f $composite_enabled)     { set $use_composite_cache "${use_composite_cache}B"; }
   if (-f $composite_file)  { set $use_composite_cache "${use_composite_cache}C"; }
   if ($use_composite_cache = "ABC") { rewrite .* /$composite_cache last; } 
   proxy_pass $proxyserver;
}

3) И дальше подключаем наши конфиги в файле виртуального хоста:
/etc/nginx/bx/site_avaliable/bx_domain.ru.conf

# Ansible managed
# Additional website http

include bx/maps/composite_ex.conf;

server {
    #limit_conn perip 3;
    
    listen 443 http2;
  
    server_name domain.ru www.domain.ru;
  
  # enable SSL connection
  include bx/conf/ssl.conf;

  access_log /var/log/nginx/access.log main;
  error_log  /var/log/nginx/error.log warn;

  #charset utf-8;
  server_name_in_redirect off;

  proxy_set_header   X-Real-IP $remote_addr;
  proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
  proxy_set_header   Host $host:443;
  proxy_set_header  HTTPS YES;
  proxy_set_header  X-Forwarded-Proto https;

    set $proxyserver  "http://127.0.0.1:8887";
  
    set $imcontenttype   "text/html; charset=utf-8";
    set $docroot      "/home/bitrix/www/domain.ru";

  index index.php;
  root "/home/bitrix/www/domain.ru";
  proxy_ignore_client_abort off;
  
  # Include parameters common to all websites
  #include bx/conf/bitrix.conf;
  include bx/conf/composite_ex.conf;

  # Include munin and nagios web
  include bx/server_monitor.conf;
}

Перезагружаем nginx и проверяем работу композита.

Недостатки:
При добавлении параметра в request_uri он может потом вылезти в ссылках в компонентах, по этому придется вносить коррекции в шаблоны компонентов, где такое произошло. Либо на обработчике события OnBeforeEndBufferContent убрать лишние параметры mobile=Y.

Теги:

композит

2 Комментировать

Комментарии: 7 7 0

Ещё 370

Предыдущие комментарии 4

Гусев Александр

Пользователь 8420 4 Апрель, 2019 11:59

Штинов Антон, понял... мне казалось, что создание отдельной мобильной версии практически равнозначна по трудозатрам адаптивной верстке... А так да, ситуации бывают разные.

0 Ещё

It Sparta: Денис Зимин

Пользователь 142174 5 Апрель, 2019 7:45

Штинов Антон, в Битриксе есть уже готовый механизм влияния на кеш композита, по одинаковому url

вешаем кастомный класс на событие OnGetStaticCacheProvider (+ можно в параметры передать нужный SITE_ID чтобы это работало только для 1 сайта на многосайтовости)

RegisterModuleDependences('main','OnGetStaticCacheProvider', $moduleId, 'CacheProvider', 'getObject', 100, "", array(SITE_ID));

ну и содержимое самого класса, где в методе getCachePrefix() можно любое значение в $key ставить. (при NULL будет работать как сейчас - по обычному)

use Bitrix\Main\Data\StaticCacheProvider;

class CacheProvider extends StaticCacheProvider
{
   public function getCachePrivateKey()
   {
      return self::getCachePrefix();
   }

   public function setUserPrivateKey()
   {
      \CHTMLPagesCache::setUserPrivateKey(self::getCachePrefix(), 0);
   }

   public function isCacheable()
   {
      return true;
   }

   public function onBeforeEndBufferContent()
   {

   }

   public static function getCachePrefix()
   {
      static $isMobile;
      if (!isset($isMobile)) {
         Mobile::Init();
         $isMobile = Mobile::isMobile();
      }

      $key = NULL;
      $key = ($isMobile) ? 'mobile' : 'desktop';

      return $key;
   }

   // $SITE_ID = SITE_ID - for situation if module update, but wizard not started
   public static function getObject($SITE_ID = SITE_ID)
   {
      if($SITE_ID == SITE_ID)
      {
         \CHTMLPagesCache::setUserPrivateKey(self::getCachePrefix(), 0);
         return new self();
      }
   }

}

Единственный нюанс такого подхода в том, что 1 хит на сайт всегда будет некомпозитный, т.к. только в срыком хите композита проставится нужная кука с этим рассчитанным ключем ($key) и далее уже будет она использоваться.
Ну и такой подход не желательно использоваться, если значение $key у пользователя может меняться при хождении по сайту, т.к. опять кука меняться будет через хит и композит будет не всегда отрабатывать.

Собственно класс позволяет и другие операции с композитом, если его поизучать.

0 Ещё

Штинов Антон

Пользователь 61272 14 Август, 2019 13:41

It Sparta: Денис Зимин, К сожалению документации по этому классу нету. И как я понимаю такое решение позволяет добавить свой ключ к кешу. Однако, это не решает проблему настройки композита со стороны nginx, там в конфигах не учитываются дополнительные параметры и куки.

0 Ещё

Группы на сайте создаются не только сотрудниками «1С-Битрикс», но и партнерами компании. Поэтому мнения участников групп могут не совпадать с позицией компании «1С-Битрикс».

Композит и поддержка нескольких шаблонов

Продукты

Управление сайтом

Битрикс24

Интернет-магазин + CRM

Решения

Для интернет-магазинов

Каталог готовых решений

Внедрение

Выбрать партнера

Проверить партнера

Стать партнером