Added email logging support (#9)

Author: Alexander Paliarush

CHANGELOG.md

@@ -23,6 +23,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+ - Added logging of all emails in HTML format to `vagrant-magento/log/email`
  - Added host wrapper script for bin/magento command on guest
  - Added ability to modify guest config files (PHP, Apache etc) directly from host IDE
  - Added ability to choose if PhpStorm configs should be removed during project reinitialization

README.md

@@ -19,6 +19,7 @@
    * [Use Magento CLI (bin/magento)](#use-magento-cli-binmagento)
    * [Debugging with XDebug](#debugging-with-xdebug)
    * [Connecting to MySQL DB](#connecting-to-mysql-db)
+   * [View emails sent by Magento](#view-emails-sent-by-magento)
    * [Accessing PHP and other config files](#accessing-php-and-other-config-files)
    * [Switch between PHP 5.6 and 7.0](#switch-between-php-56-and-70)
    * [Multiple Magento instances](#multiple-magento-instances)
@@ -134,6 +135,7 @@ Note, that semantic versioning is only used for `x.0` branches (not for `develop
  1. Make sure that you used `vagrant-magento` directory as project root in PHP Storm (not `vagrant-magento/magento2ce`)
  1. If code is not synchronized properly on Windows hosts (or when NFS mode is disabled in [config.yaml](etc/config.yaml.dist) explicitly), make sure that PhpStorm is running before making any changes in the code. This is important because otherwise PhpStorm will not be able to detect changes and upload them to the guest machine
  1. Please make sure that currently installed software, specified in [requirements section](#requirements), meets minimum version requirement
+ 1. If MySQL fails to start and Magento reinstallation fails with `ERROR 2002 (HY000): Can't connect to local MySQL server through socket '/var/run/mysqld/mysqld.sock' (13)`, try to run login to virtual machine using `vagrant ssh` and then run `sudo dpkg-reconfigure mysql-server-5.6`, then `sudo service mysql restart.`
 
 ## Day-to-day development scenarios
 
@@ -212,6 +214,10 @@ To debug Magento Setup script, go to [Magento installation script](scripts/guest
 
 Answer can be found [here](https://github.com/paliarush/magento2-vagrant-for-developers/issues/8)
 
+### View emails sent by Magento
+
+All emails are saved to 'vagrant-magento/log/email' in HTML format.
+
 ### Accessing PHP and other config files
 
 It is possible to view/modify majority of guest machine config files directly from IDE on the host. They will be accessible in [etc/guest](etc/guest) directory only when guest machine is running. The list of accessible configs includes: PHP, Apache, Mysql, Varnish, RabbitMQ.

Vagrantfile

@@ -49,6 +49,7 @@ Vagrant.configure(VAGRANT_API_VERSION) do |config|
     config.vm.synced_folder '.', '/vagrant', disabled: true
     config.vm.synced_folder './etc', '/vagrant/etc', mount_options: ["dmode=775,fmode=664"]
     config.vm.synced_folder './scripts', '/vagrant/scripts'
+    config.vm.synced_folder './log', '/vagrant/log'
     config.vm.synced_folder './.idea', '/vagrant/.idea', create: true
     if use_nfs_for_synced_folders
         guest_magento_dir = host_magento_dir

init_project.sh

@@ -52,6 +52,7 @@ if [ ${force_project_cleaning} -eq 1 ]; then
     rm -rf ${vagrant_dir}/.vagrant ${vagrant_dir}/etc/guest
     mkdir ${vagrant_dir}/etc/guest
     mv ${vagrant_dir}/etc/.gitignore.back  ${vagrant_dir}/etc/guest/.gitignore
+    cd ${vagrant_dir}/log && mv email/.gitignore email_gitignore.back && rm -rf email && mkdir email && mv email_gitignore.back email/.gitignore
     if [ ${force_codebase_cleaning} -eq 1 ]; then
         rm -rf ${magento_ce_dir}
     fi

log/email/.gitignore

@@ -0,0 +1 @@
+*

scripts/guest/log_email

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+email_log_dir=$1
+if [ ! -d ${email_log_dir} ]; then
+    mkdir -p ${email_log_dir}
+fi
+
+# Construct email file path
+current_time=$( date +"%Y-%m-%d_%H-%M-%S" )
+# Add random suffix to file name just in case there several emails sent in one second
+random_suffix=$(( RANDOM % 100 ))
+email_file_path="${email_log_dir}/${current_time}_${random_suffix}"
+
+raw_email_output=$(cat)
+
+# Add email topic to file name
+pattern="Subject: (.*)\sX-PHP-Originating-Script:"
+if [[ "${raw_email_output}" =~ ${pattern} ]]; then
+    email_topic=${BASH_REMATCH[1]}
+    email_file_path="${email_file_path}_${email_topic}"
+fi
+email_file_path="${email_file_path}.html"
+
+# Output content
+echo ${raw_email_output} > "${email_file_path}"
+
+# Process raw content of an email to make it a valid HTML
+sed -i "s|.*<\!DOCTYPE|<\!DOCTYPE|g" "${email_file_path}"
+sed -i "s|=3D|=|g" "${email_file_path}"
+sed -i "s|=0A||g" "${email_file_path}"
+sed -i "s|= ||g" "${email_file_path}"

scripts/provision/configure_environment_recurring.sh

@@ -29,7 +29,6 @@ function init_php56 () {
 set +x
 
 use_php7=$4
-
 vagrant_dir="/vagrant"
 
 # Remove configs from host in case of force stop of virtual machine before linking restored ones
@@ -74,3 +73,16 @@ else
 fi
 service apache2 restart
 #end Setup PHP
+
+# Enable email logging
+if [ ${use_php7} -eq 1 ]; then
+    php_ini_file="/etc/php/7.0/cli/php.ini"
+else
+    php_ini_file="/etc/php/5.6/cli/php.ini"
+fi
+pattern=";sendmail_path"
+php_config_content="$(cat ${php_ini_file})"
+if [[ ${php_config_content} =~ ${pattern} ]]; then
+    sed -i "s|;sendmail_path =|sendmail_path = \"/vagrant/scripts/guest/log_email ${vagrant_dir}/log/email\"|g" ${php_ini_file}
+    service apache2 restart
+fi