From 0ae38238535e7a95fead4eeb38250d712b1d3d83 Mon Sep 17 00:00:00 2001
From: PhilW <roundcube@tehinterweb.co.uk>
Date: Wed, 23 Oct 2019 19:14:11 +0100
Subject: [PATCH] rewrite skin_logo config

---
 config/defaults.inc.php                | 36 +++++++++++++++++++++-----
 program/include/rcmail_output_html.php | 25 ++++++++++++++----
 2 files changed, 49 insertions(+), 12 deletions(-)

diff --git a/config/defaults.inc.php b/config/defaults.inc.php
index 2b8c32802..a747c7d04 100644
--- a/config/defaults.inc.php
+++ b/config/defaults.inc.php
@@ -393,13 +393,35 @@ $config['support_url'] = '';
 // replace Roundcube logo with this image
 // specify an URL relative to the document root of this Roundcube installation
 // an array can be used to specify different logos for specific template files
-// '*' for default logo
-// ':favicon' for favicon
-// ':print' for logo on all print templates (e.g. messageprint, contactprint)
-// ':small' for small screen logo in Elastic
-// different logos can be specified for different skins by prefixing the skin name to the array key
-// config applied in order: <skin>:<template>, <skin>:*, <template>, *
-// for example array("*" => "/images/roundcube_logo.png", "messageprint" => "/images/roundcube_logo_print.png", "elastic:*" => "/images/logo.png")
+// the array key specifies the template(s) the logo should be applied to while the
+// value should be the relative URL of the image.
+//
+// the array key is made up of (up to) 3 parts:
+// the skin name (optional)
+// the template name (or * for all templates)
+// the logo type (optional) the type attribute is used for logos used on multiple templates
+//   the available types include '[favicon]' for favicon, '[print]' for logo on all print
+//   templates (e.g. messageprint, contactprint) and '[small]' for small screen logo in supported skins
+//
+// config applied in order: <skin>:<template>, <skin>:<template>, <skin>:*, <template>, *
+/*
+ * example config for skin_logo
+ *
+   array(
+     // show the image /images/logo_login_small.png for the Login screen in the Elastic skin on small screens
+     "elastic:login[small]" => "/images/logo_login_small.png",
+     // show the image /images/logo_login.png for the Login screen in the Elastic skin
+     "elastic:login" => "/images/logo_login.png",
+     // show the image /images/logo_small.png in the Elastic skin
+     "elastic[small]" => "/images/logo_small.png",
+     // show the image /images/larry.png in the Larry skin
+     "larry:*" => "/images/larry.png",
+     // show the image /images/logo_login.png on the login template in all skins
+     "login" => "/images/logo_login.png",
+     // show the image /images/logo_print.png for all print type logos in all skins
+     "[print]" => "/images/logo_print.png",
+   );
+*/
 $config['skin_logo'] = null;
 
 // automatically create a new Roundcube user when log-in the first time.
diff --git a/program/include/rcmail_output_html.php b/program/include/rcmail_output_html.php
index a2c6f682f..05b18f8c1 100644
--- a/program/include/rcmail_output_html.php
+++ b/program/include/rcmail_output_html.php
@@ -1353,7 +1353,7 @@ EOF;
                 else if ($object == 'logo') {
                     $attrib += array('alt' => $this->xml_command(array('', 'object', 'name="productname"')));
 
-                    if (!empty($attrib['type']) && ($template_logo = $this->get_template_logo(':' . $attrib['type'], true)) !== null) {
+                    if (!empty($attrib['type']) && ($template_logo = $this->get_template_logo(null, $attrib['type'], true)) !== null) {
                         $attrib['src'] = $template_logo;
                     }
                     else if (($template_logo = $this->get_template_logo()) !== null) {
@@ -1363,7 +1363,7 @@ EOF;
                     // process alternative logos (eg for Elastic small screen)
                     foreach ($attrib as $key => $value) {
                         if (preg_match('/data-src-(.*)/', $key, $matches)) {
-                            if (($template_logo = $this->get_template_logo(':' . $matches[1], true)) !== null) {
+                            if (($template_logo = $this->get_template_logo(null, $matches[1], true)) !== null) {
                                 $attrib[$key] = $template_logo;
                             }
 
@@ -1447,7 +1447,7 @@ EOF;
 
                             // special handling for favicon
                             if ($object == 'links' && $name == 'shortcut icon' && empty($args[$param])) {
-                                if ($href = $this->get_template_logo(':favicon', true)) {
+                                if ($href = $this->get_template_logo(null, 'favicon', true)) {
                                     $args[$param] = $href;
                                 }
                                 else if ($href = $this->config->get('favicon', '/images/favicon.ico')) {
@@ -2449,11 +2449,13 @@ EOF;
      *
      * @param string  $name     Name of the logo to check for
      *                          default is current template
+     * @param string  $type     Type of the logo to check for (e.g. 'print' or 'small')
+     *                          default is null (no special type)
      * @param boolean $strict   True if logo should only be returned for specific template
      *
      * @return string image URL
      */
-    protected function get_template_logo($name = null, $strict = false)
+    protected function get_template_logo($name = null, $type = null, $strict = false)
     {
         $template_logo = null;
 
@@ -2463,13 +2465,26 @@ EOF;
         }
 
         $template_names = array(
+            $this->skin_name . ':' . $name . '[' . $type . ']',
             $this->skin_name . ':' . $name,
+            $this->skin_name . ':*[' . $type . ']',
             $this->skin_name . ':*',
+            $this->skin_name . '[' . $type . ']',
+            '*:' . $name . '[' . $type . ']',
+            '*:' . $name,
+            $name . '[' . $type . ']',
             $name,
+            '*[' . $type . ']',
             '*',
+            '[' . $type . ']',
         );
 
-        // If strict matching then remove wildcard options
+        // If no type is specified then remove those options from the list
+        if (empty($type)) {
+            $template_names = preg_grep("/\\[\]$/", $template_names, PREG_GREP_INVERT);
+        }
+
+        // If strict matching then remove wild card options
         if ($strict) {
             $template_names = preg_grep("/\*$/", $template_names, PREG_GREP_INVERT);
         }