Merge branch 'develop' into develop

Author: mrrobot47

src/helper/Site_Letsencrypt.php

@@ -34,6 +34,7 @@
 use League\Flysystem\Adapter\Local;
 use League\Flysystem\Adapter\NullAdapter;
 use GuzzleHttp\Client;
+use function \EE\Site\Utils\reload_global_nginx_proxy;
 
 
 class Site_Letsencrypt {
@@ -109,13 +110,19 @@ private function getSecureHttpClient() {
 		);
 	}
 
-
+	/**
+	 * Function to register mail to letsencrypt.
+	 *
+	 * @param string $email Mail id to be registered.
+	 *
+	 * @return bool Success.
+	 */
 	public function register( $email ) {
 		try {
 			$this->client->registerAccount( null, $email );
 		} catch ( \Exception $e ) {
 			\EE::warning( $e->getMessage() );
-			\EE::warning( 'It seems you\'re in local environment or there is some issue with network, please check logs. Skipping letsencrypt.' );
+			\EE::warning( 'It seems you\'re in local environment or used invalid email or there is some issue with network, please check logs. Skipping letsencrypt.' );
 
 			return false;
 		}
@@ -124,7 +131,15 @@ public function register( $email ) {
 		return true;
 	}
 
-	public function authorize( Array $domains, $site_root, $wildcard = false ) {
+	/**
+	 * Function to authorize the letsencrypt request and get the token for challenge.
+	 *
+	 * @param array $domains Domains to be authorized.
+	 * @param bool $wildcard Is the authorization for wildcard or not.
+	 *
+	 * @return bool Success.
+	 */
+	public function authorize( Array $domains, $wildcard = false ) {
 		$solver     = $wildcard ? new SimpleDnsSolver( null, new ConsoleOutput() ) : new SimpleHttpSolver();
 		$solverName = $wildcard ? 'dns-01' : 'http-01';
 		try {
@@ -165,10 +180,17 @@ public function authorize( Array $domains, $site_root, $wildcard = false ) {
 			if ( ! $wildcard ) {
 				$token   = $authorizationChallenge->toArray()['token'];
 				$payload = $authorizationChallenge->toArray()['payload'];
-				\EE::launch( "mkdir -p $site_root/app/src/.well-known/acme-challenge/" );
-				\EE::debug( "Creating challange file $site_root/app/src/.well-known/acme-challenge/$token" );
-				file_put_contents( "$site_root/app/src/.well-known/acme-challenge/$token", $payload );
-				\EE::launch( "chown www-data: $site_root/app/src/.well-known/acme-challenge/$token" );
+
+				$fs = new \Symfony\Component\Filesystem\Filesystem();
+				$fs->copy( SITE_TEMPLATE_ROOT . '/vhost.d_default_letsencrypt.mustache', EE_CONF_ROOT . '/nginx/vhost.d/default' );
+				$challange_dir = EE_CONF_ROOT . '/nginx/html/.well-known/acme-challenge';
+				if ( ! $fs->exists( $challange_dir ) ) {
+					$fs->mkdir( $challange_dir );
+				}
+				$challange_file = $challange_dir . '/' . $token;
+				\EE::debug( 'Creating challange file ' . $challange_file );
+				$fs->dumpFile( $challange_file, $payload );
+				reload_global_nginx_proxy();
 			}
 		}
 
@@ -519,11 +541,20 @@ public function status() {
 		$table->render();
 	}
 
-	public function cleanup( $site_root ) {
-		$challange_dir = "$site_root/app/src/.well-known";
-		if ( file_exists( "$site_root/app/src/.well-known" ) ) {
-			\EE::debug( 'Cleaning up webroot files.' );
-			\EE\Utils\delete_dir( $challange_dir );
+	/**
+	 * Cleanup created challenge files and specific rule sets for it.
+	 */
+	public function cleanup() {
+
+		$fs = new \Symfony\Component\Filesystem\Filesystem();
+
+		$challange_dir = EE_CONF_ROOT . '/nginx/html/.well-known';
+		$challange_rule_file = EE_CONF_ROOT . '/nginx/vhost.d/default';
+		if ( $fs->exists( $challange_rule_file ) ) {
+			$fs->remove( $challange_rule_file );
+		}
+		if ( $fs->exists( $challange_dir ) ) {
+			$fs->remove( $challange_dir );
 		}
 	}
 }

src/helper/class-ee-site.php

@@ -422,7 +422,7 @@ protected function init_ssl( $site_url, $site_fs_path, $ssl_type, $wildcard = fa
 	 */
 	protected function init_le( $site_url, $site_fs_path, $wildcard = false ) {
 
-		\EE::debug( "Wildcard in init_le: $wildcard" );
+		\EE::debug( 'Wildcard in init_le: ' . ( bool ) $wildcard );
 
 		$this->site_data['site_url']          = $site_url;
 		$this->site_data['site_fs_path']      = $site_fs_path;
@@ -438,7 +438,7 @@ protected function init_le( $site_url, $site_fs_path, $wildcard = false ) {
 
 		$domains = $this->get_cert_domains( $site_url, $wildcard );
 
-		if ( ! $client->authorize( $domains, $this->site_data['site_fs_path'], $wildcard ) ) {
+		if ( ! $client->authorize( $domains, $wildcard ) ) {
 			return;
 		}
 		if ( $wildcard ) {
@@ -523,7 +523,7 @@ public function le( $args = [], $assoc_args = [] ) {
 		$client->request( $this->site_data['site_url'], $san, $this->le_mail, $force );
 
 		if ( ! $this->site_data['site_ssl_wildcard'] ) {
-			$client->cleanup( $this->site_data['site_fs_path'] );
+			$client->cleanup();
 		}
 		reload_global_nginx_proxy();
 	}

src/helper/site-utils.php

@@ -171,7 +171,7 @@ function generate_global_docker_compose_yml( Filesystem $fs ) {
 				EE_CONF_ROOT . '/nginx/conf.d:/etc/nginx/conf.d',
 				EE_CONF_ROOT . '/nginx/htpasswd:/etc/nginx/htpasswd',
 				EE_CONF_ROOT . '/nginx/vhost.d:/etc/nginx/vhost.d',
-				'/usr/share/nginx/html',
+				EE_CONF_ROOT . '/nginx/html:/usr/share/nginx/html',
 				'/var/run/docker.sock:/tmp/docker.sock:ro',
 			],
 			'networks'       => [

src/site-type/Site_HTML_Docker.php

@@ -62,7 +62,14 @@ public function generate_docker_compose_yml( array $filters = [] ) {
 
 		$binding = [
 			'services' => $base,
-			'network'  => true,
+			'network'  => [
+				'networks_labels' => [
+					'label' => [
+						[ 'name' => 'org.label-schema.vendor=EasyEngine' ],
+						[ 'name' => 'io.easyengine.site=${VIRTUAL_HOST}' ],
+					],
+				],
+			],
 		];
 
 		$docker_compose_yml = mustache_render( SITE_TEMPLATE_ROOT . '/docker-compose.mustache', $binding );

templates/docker-compose.mustache

@@ -49,6 +49,12 @@ services:
 networks:
   site-network:
     name: ${VIRTUAL_HOST}
+    {{#networks_labels}}
+    labels:
+    {{#label}}
+     - "{{name}}"
+    {{/label}}
+    {{/networks_labels}}
   global-network:
     external:
       name: ee-global-network

templates/vhost.d_default_letsencrypt.mustache

@@ -0,0 +1,7 @@
+location ^~ /.well-known/acme-challenge/ {
+    auth_basic off;
+    allow all;
+    root /usr/share/nginx/html;
+    try_files $uri =404;
+    break;
+}