Merge pull request #244 from greybyte/vhost_config_variables

Variable substitution in vhost specialconfig

lng/english.lng.php

@@ -1843,9 +1843,12 @@ $lng['admin']['configfiles']['commands'] = '<span class="red">Commands:</span> T
 $lng['admin']['configfiles']['files'] = '<span class="red">Configfiles:</span> This is an example of the contents of a configuration file. The commands before these textfields should open an editor with the target file. Just copy and paste the contents into the editor and save the file.<br><br><span class="red">Please note:</span> The MySQL-password has not been replaced for security reasons. Please replace "MYSQL_PASSWORD" on your own. If you forgot your MySQL-password you\'ll find it in "lib/userdata.inc.php"';
 $lng['serversettings']['apache_itksupport']['title'] = 'Use modifications for Apache ITK-MPM';
 $lng['serversettings']['apache_itksupport']['description'] = '<strong class="red">ATTENTION:</strong> use only if you acutally have apache itk-mpm enabled<br />otherwise your webserver will not be able to start';
-
 $lng['integrity_check']['DatabaseCharset'] = 'Characterset of database (should be UTF-8)';
 $lng['integrity_check']['DomainIpTable'] = 'IP &lt;&dash;&gt; domain references';
 $lng['integrity_check']['SubdomainSslRedirect'] = 'False SSL-redirect flag for non-ssl domains';
 $lng['integrity_check']['FroxlorLocalGroupMemberForFcgidPhpFpm'] = 'froxlor-user in the customer groups (for FCGID/php-fpm)';
 $lng['integrity_check']['WebserverGroupMemberForFcgidPhpFpm'] = 'Webserver-user in the customer groups (for FCGID/php-fpm)';
+$lng['admin']['specialsettings_replacements'] = "You can use the following variables:<br/><code>{DOMAIN}</code>, <code>{DOCROOT}</code>, <code>{CUSTOMER}</code>, <code>{IP}</code>, <code>{PORT}</code>, <code>{SCHEME}</code><br/>";
+$lng['serversettings']['default_vhostconf']['description'] = 'The content of this field will be included into this ip/port vHost container directly. '.$lng['admin']['specialsettings_replacements'].' Attention: The code won\'t be checked for any errors. If it contains errors, webserver might not start again!';
+$lng['serversettings']['default_vhostconf_domain']['description'] = 'The content of this field will be included into the domain vHost container directly. '.$lng['admin']['specialsettings_replacements'].' Attention: The code won\'t be checked for any errors. If it contains errors, webserver might not start again!';
+

lng/german.lng.php

@@ -1570,9 +1570,11 @@ $lng['admin']['configfiles']['commands'] = '<span class="red">Kommandos:</span>
 $lng['admin']['configfiles']['files'] = '<span class="red">Konfigurationsdateien:</span> Dies ist der Inhalt einer Konfigurationsdatei. Der Befehl direkt vor dem Textfeld sollte einen Editor mit der Zeildatei öffnen. Der Inhalt kann nun einfach kopiert und in den Editor eingefügt und die Datei gespeichert werden.<br><br><span class="red">Beachten Sie:</span> Das MySQL-Passwort wurde aus Sicherheitsgründen nicht ersetzt. Bitte ersetzen Sie "MYSQL_PASSWORD" manuell durch das entsprechende Passwort. Falls Sie es vergessen haben sollten, finden Sie es in der Datei "lib/userdata.inc.php".';
 $lng['serversettings']['apache_itksupport']['title'] = 'Anpassungen für Apache ITK-MPM verwenden';
 $lng['serversettings']['apache_itksupport']['description'] = '<div class="red">Achtung: Bitte nur verwenden, wenn wirklich Apache itk-mpm verwendet wird, ansonsten wird der Webserver nicht starten.</div>';
-
 $lng['integrity_check']['DatabaseCharset'] = 'Characterset der Datenbank (sollte UTF-8 sein)';
 $lng['integrity_check']['DomainIpTable'] = 'IP &lt;&dash;&gt; Domain Verkn&uuml;pfung';
 $lng['integrity_check']['SubdomainSslRedirect'] = 'Falsches SSL-redirect Flag bei nicht-ssl Domains';
 $lng['integrity_check']['FroxlorLocalGroupMemberForFcgidPhpFpm'] = 'froxlor-Benutzer in Kunden Gruppen (f&uuml;r FCGID/php-fpm)';
 $lng['integrity_check']['WebserverGroupMemberForFcgidPhpFpm'] = 'Webserver-Benutzer in Kunden Gruppen (f&uuml;r FCGID/php-fpm)';
+$lng['admin']['specialsettings_replacements'] = "Die folgenden Variablen können verwendet werden:<br/><code>{DOMAIN}</code>, <code>{DOCROOT}</code>, <code>{CUSTOMER}</code>, <code>{IP}</code>, <code>{PORT}</code>, <code>{SCHEME}</code><br/>";
+$lng['serversettings']['default_vhostconf']['description'] = 'Der Inhalt dieses Feldes wird direkt in den IP/Port-vHost-Container übernommen. '.$lng['admin']['specialsettings_replacements'].'<br /><strong>ACHTUNG:</strong> Der Code wird nicht auf Fehler geprüft. Etwaige Fehler werden also auch übernommen. Der Webserver könnte nicht mehr starten!';
+$lng['serversettings']['default_vhostconf_domain']['description'] = 'Der Inhalt dieses Feldes wird direkt in jeden Domain-vHost-Container übernommen. '. $lng['admin']['specialsettings_replacements'].'<strong>ACHTUNG:</strong> Der Code wird nicht auf Fehler geprüft. Etwaige Fehler werden also auch übernommen. Der Webserver könnte nicht mehr starten!';

scripts/classes/class.HttpConfigBase.php

@@ -0,0 +1,38 @@
+<?php
+/***
+ * Class HttpConfigBase
+ *
+ * Base class for all HTTP server configs
+ *
+ */
+class HttpConfigBase {
+
+	/**
+	 * process special config as template, by substituting {VARIABLE} with the
+	 * respective value.
+	 *
+	 * The following variables are known at the moment:
+	 *
+	 * {DOMAIN}         - domain name
+	 * {IP}             - IP for this domain
+	 * {PORT}           - Port for this domain
+	 * {CUSTOMER}       - customer name
+	 * {IS_SSL}         - evaluates to 'ssl' if domain/ip is ssl, otherwise it is an empty string
+	 * {DOCROOT}        - document root for this domain
+	 *
+	 * @param $template
+	 * @return string
+	 */
+	protected function processSpecialConfigTemplate($template, $domain, $ip, $port, $is_ssl_vhost) {
+		$templateVars = array(
+			'DOMAIN' => $domain['domain'],
+			'CUSTOMER' => $domain['loginname'],
+			'IP' => $ip,
+			'PORT' => $port,
+			'SCHEME' => ($is_ssl_vhost)?'https':'http',
+			'DOCROOT' => $domain['documentroot']
+		);
+		return replace_variables($template, $templateVars);
+	}
+
+} 

scripts/jobs/cron_tasks.inc.http.10.apache.php

@@ -17,7 +17,9 @@
  *
  */
 
-class apache {
+require_once(dirname(__FILE__).'/../classes/class.HttpConfigBase.php');
+
+class apache extends HttpConfigBase {
 	private $logger = false;
 	private $debugHandler = false;
 	private $idnaConvert = false;
@@ -42,7 +44,6 @@ class apache {
 		$this->logger = $logger;
 		$this->debugHandler = $debugHandler;
 		$this->idnaConvert = $idnaConvert;
-
 	}
 
 
@@ -315,7 +316,12 @@ class apache {
 				 */
 
 				if ($row_ipsandports['specialsettings'] != '') {
-					$this->virtualhosts_data[$vhosts_filename] .= $row_ipsandports['specialsettings'] . "\n";
+					$this->virtualhosts_data[$vhosts_filename] .= $this->processSpecialConfigTemplate(
+							$row_ipsandports['specialsettings'],
+							$domain,
+							$row_ipsandports['ip'],
+							$row_ipsandports['port'],
+							$row_ipsandports['ssl'] == '1') . "\n";
 				}
 
 				if ($row_ipsandports['ssl'] == '1' && Settings::Get('system.use_ssl') == '1') {
@@ -656,7 +662,6 @@ class apache {
 		return $vhost_filename;
 	}
 
-
 	/**
 	 * We compose the virtualhost entry for one domain
 	 */
@@ -711,7 +716,12 @@ class apache {
 			}
 
 			if ($ipandport['default_vhostconf_domain'] != '') {
-				$_vhost_content .= $ipandport['default_vhostconf_domain'] . "\n";
+				$_vhost_content .= $this->processSpecialConfigTemplate(
+										$ipandport['default_vhostconf_domain'],
+										$domain,
+										$domain['ip'],
+										$domain['port'],
+										$ssl_vhost) . "\n";
 			}
 			$ipportlist .= $ipport;
 		}
@@ -820,7 +830,12 @@ class apache {
 			$vhost_content .= $this->getLogfiles($domain);
 
 			if ($domain['specialsettings'] != '') {
-				$vhost_content .= $domain['specialsettings'] . "\n";
+				$vhost_content .= $this->processSpecialConfigTemplate(
+						$domain['specialsettings'],
+						$domain,
+						$domain['ip'],
+						$domain['port'],
+						$ssl_vhost) . "\n";
 			}
 
 			if ($_vhost_content != '') {
@@ -828,7 +843,12 @@ class apache {
 			}
 
 			if (Settings::Get('system.default_vhostconf') != '') {
-				$vhost_content .= Settings::Get('system.default_vhostconf') . "\n";
+				$vhost_content .= $this->processSpecialConfigTemplate(
+						Settings::Get('system.default_vhostconf'),
+						$domain,
+						$domain['ip'],
+						$domain['port'],
+						$ssl_vhost) . "\n";
 			}
 		}
 

scripts/jobs/cron_tasks.inc.http.20.lighttpd.php

@@ -18,7 +18,9 @@
  * @TODO ssl-redirect to non-standard port
  */
 
-class lighttpd {
+require_once(dirname(__FILE__).'/../classes/class.HttpConfigBase.php');
+
+class lighttpd extends HttpConfigBase {
 	private $logger = false;
 	private $debugHandler = false;
 	private $idnaConvert = false;
@@ -145,7 +147,13 @@ class lighttpd {
 				}
 
 				if ($row_ipsandports['specialsettings'] != '') {
-					$this->lighttpd_data[$vhost_filename].= $row_ipsandports['specialsettings'] . "\n";
+					$this->lighttpd_data[$vhost_filename].= $this->processSpecialConfigTemplate(
+							$row_ipsandports['specialsettings'],
+							$domain,
+							$row_ipsandports['ip'],
+							$row_ipsandports['port'],
+							$row_ipsandports['ssl'] == '1'
+					). "\n";
 				}
 
 				$this->lighttpd_data[$vhost_filename].= '}' . "\n";
@@ -453,15 +461,30 @@ class lighttpd {
 					$vhost_content.= $this->getSslSettings($domain, $ssl_vhost);
 
 					if ($domain['specialsettings'] != "") {
-						$vhost_content.= $domain['specialsettings'] . "\n";
+						$vhost_content.= $this->processSpecialConfigTemplate(
+								$domain['specialsettings'],
+								$domain,
+								$domain['ip'],
+								$domain['port'],
+								$ssl_vhost). "\n";
 					}
 
 					if ($ipandport['default_vhostconf_domain'] != '') {
-						$vhost_content.= $ipandport['default_vhostconf_domain'] . "\n";
+						$vhost_content.= $this->processSpecialConfigTemplate(
+								$ipandport['default_vhostconf_domain'],
+								$domain,
+								$domain['ip'],
+								$domain['port'],
+								$ssl_vhost) . "\n";
 					}
 
 					if (Settings::Get('system.default_vhostconf') != '') {
-						$vhost_content.= Settings::Get('system.default_vhostconf') . "\n";
+						$vhost_content.= $this->processSpecialConfigTemplate(
+							Settings::Get('system.default_vhostconf'),
+								$domain,
+								$domain['ip'],
+								$domain['port'],
+								$ssl_vhost). "\n";
 					}
 				}
 				$vhost_content.= $this->getLogFiles($domain);

scripts/jobs/cron_tasks.inc.http.30.nginx.php

@@ -15,7 +15,9 @@
  *
  */
 
-class nginx {
+require_once(dirname(__FILE__).'/../classes/class.HttpConfigBase.php');
+
+class nginx extends HttpConfigBase {
 	private $logger = false;
 	private $debugHandler = false;
 	private $idnaConvert = false;
@@ -187,7 +189,14 @@ class nginx {
 				$this->nginx_data[$vhost_filename] .= "\t".'}'."\n";
 
 				if ($row_ipsandports['specialsettings'] != '') {
-					$this->nginx_data[$vhost_filename].= $row_ipsandports['specialsettings'] . "\n";
+					$this->nginx_data[$vhost_filename].= $this->processSpecialConfigTemplate(
+							$row_ipsandports['specialsettings'],
+							array('domain'=> Settings::Get('system.hostname'),
+								  'loginname' => Settings::Get('phpfpm.vhost_httpuser'),
+								  'documentroot'=> $mypath),
+							$row_ipsandports['ip'],
+							$row_ipsandports['port'],
+							$row_ipsandports['ssl'] == '1'). "\n";
 				}
 
 				/**
@@ -365,7 +374,12 @@ class nginx {
 			}
 
 			if ($ipandport['default_vhostconf_domain'] != '') {
-				$_vhost_content .= $ipandport['default_vhostconf_domain'] . "\n";
+				$_vhost_content .= $this->processSpecialConfigTemplate(
+						$ipandport['default_vhostconf_domain'],
+						$domain,
+						$domain['ip'],
+						$domain['port'],
+						$ssl_vhost). "\n";
 			}
 
 			$vhost_content.= "\t" . 'listen ' . $ipport . ($ssl_vhost == true ? ' ssl' : '') . ';' . "\n";
@@ -427,7 +441,13 @@ class nginx {
 				$vhost_content.= isset($this->needed_htpasswds[$domain['id']]) ? $this->needed_htpasswds[$domain['id']] . "\n" : '';
 
 				if ($domain['specialsettings'] != "") {
-					$vhost_content = $this->mergeVhostCustom($vhost_content, $domain['specialsettings']);
+					$vhost_content = $this->mergeVhostCustom($vhost_content, $this->processSpecialConfigTemplate(
+						$domain['specialsettings'],
+						$domain,
+						$domain['ip'],
+						$domain['port'],
+						$ssl_vhost
+					));
 				}
 
 				if ($_vhost_content != '') {
@@ -435,7 +455,13 @@ class nginx {
 				}
 
 				if (Settings::Get('system.default_vhostconf') != '') {
-					$vhost_content = $this->mergeVhostCustom($vhost_content, Settings::Get('system.default_vhostconf')."\n");
+					$vhost_content = $this->mergeVhostCustom($vhost_content,
+						$this->processSpecialConfigTemplate(
+							Settings::Get('system.default_vhostconf'),
+							$domain,
+							$domain['ip'],
+							$domain['port'],
+							$ssl_vhost)."\n");
 				}
 			}
 		}