Added Sancho Mail cronjob (CI)

. jobs/AmpelMail.php: 
  -- generates ampel mails for new and for overdue mails
  -- this script is run by the cronjob

. sancho_helper.php: 
  -- generates and sends Sancho Mails with Sancho Design and Layout using Sancho-mail-templates

. Ampel_model.php: functions to retrieve correct ampeln

. Sancho pictures: 
  -- sancho_header_neue_nachrichten_in_ampelsystem: is set by default
  -- sancho_header_TEMPLATE.xcf: template to quickly reproduce new sancho header images (change the text and export as jpg)

application/controllers/jobs/AmpelMail.php

@@ -0,0 +1,214 @@
+<?php
+/**
+ * FH-Complete
+ *
+ * @package		FHC-API
+ * @author		FHC-Team
+ * @copyright	Copyright (c) 2016, fhcomplete.org
+ * @license		GPLv3
+ * @link		http://fhcomplete.org
+ * @since		Version 1.0
+ * @filesource
+ */
+
+if (! defined('BASEPATH'))
+	exit('No direct script access allowed');
+
+class AmpelMail extends FHC_Controller
+{
+	const CIS_AMPELVERWALTUNG_URL =
+		CIS_ROOT. "index.php?sprache=German&content_id=&menu=".
+		CIS_ROOT. "menu.php?content_id=&content=".
+		CIS_ROOT. "private/tools/ampelverwaltung.php";
+	
+	/**
+	 * Constructor
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+
+		// Allow script execution only from CLI
+		if ($this->input->is_cli_request())
+		{
+			$cli = true;
+		}
+		else
+		{
+			$this->output->set_status_header(403, 'Jobs must be run from the CLI');
+			echo "Jobs must be run from the CLI";
+			exit;
+		}
+		
+		// Load models
+		$this->load->model('content/Ampel_model', 'AmpelModel');
+		$this->load->model('person/Person_model', 'PersonModel');
+		
+		// Load helpers
+		$this->load->helper('sancho');
+	}
+
+	/**
+	 * Main function index as help
+	 *
+	 * @return	void
+	 */
+	public function index()
+	{
+		$result = "The following are the available command line interface commands\n\n";
+		$result .= "php index.ci.php jobs/AmpelMail generateAmpelMail";
+
+		echo $result. PHP_EOL;
+	}
+	
+	/**
+	 * Generates mail content for new and overdue Ampeln, which
+	 * 1. are not confirmed by the user yet and
+	 * 2. are marked to be sent by email
+	 * Ampel is new when inserted within the last 7 days before the cronjob runs (as cronjob runs weekly)
+	 * Ampel is overdue when the cronjob runs after the deadline date.
+	 * @return void
+	 */
+	public function generateAmpelMail()
+	{
+		// Get all notifications, that are not expired, not before vorlaufzeit AND email is true
+		$result_active_ampeln = $this->AmpelModel->active(true);
+
+		// Stores users, description, deadline and system-link of notifications
+		$new_ampel_data_arr = array(); // data of new notifications that are not confirmed
+		$overdue_ampel_data_arr = array(); // data of overdue notifications that are not confirmed
+
+		if (hasData($result_active_ampeln))
+		{
+			$ampel_arr = $result_active_ampeln->retval;
+			
+			// Loop through ampeln
+			foreach ($ampel_arr as $ampel)
+			{
+				$ampel_id = $ampel->ampel_id;
+				$now = date_create(date('Y-m-d'));
+				$deadline = date_create($ampel->deadline);
+				$insert_date = date_create($ampel->insertamum);
+				$qry_all_ampel_user = $ampel->benutzer_select; // sql select to get all user who get this ampel
+				$new = false;
+				$overdue = false;
+
+				// get all user, who get this ampel
+				$result_ampel_user = $this->AmpelModel->execBenutzerSelect($qry_all_ampel_user);
+				
+				if (hasData($result_ampel_user))
+				{
+					$ampel_user_arr = $result_ampel_user->retval;
+					
+					// loop through all user, who get this ampel
+					foreach ($ampel_user_arr as $ampel_user)
+					{
+						$uid = $ampel_user->uid;
+
+						// break if ampel was almost confirmed by the user
+						if($this->AmpelModel->isConfirmed($ampel_id, $uid)) break;
+
+						// check if ampel is new (inserted within last week, as cronjob will run every week)
+						if ($now->diff($insert_date)->days <= 7) $new = true;
+
+						//check if ampel is overdue
+						if ($now > $deadline) $overdue = true;
+
+						// if ampel is new
+						if ($new)
+						{
+							$html_text = '<p><strong>'. strtoupper($ampel->kurzbz). '</strong></p><br>';
+
+							// create template-specific data array of new notifications
+							// if uid already exists in the array, only the html text will be added to the existing html text
+							$new_ampel_data_arr =
+								$this->_getAmpelContentData($uid, $html_text, $new_ampel_data_arr);
+						}
+
+						// if ampel is overdue
+						if ($overdue)
+						{
+							$html_text = '
+								<p><strong>'. strtoupper($ampel->kurzbz). '</strong><br>
+								<small>
+									<i style="color: #65696E;">Die Deadline für die Bestätigung war am 
+										<span style="color: #FF0000;">'. date_format($deadline, 'Y-m-d'). '</span>
+									</i>
+								</small></p><br>';
+
+							// create template-specific data array of overdue notifications
+							// if uid already exists in the array, only the html text will be added to the existing html text
+							$overdue_ampel_data_arr =
+								$this->_getAmpelContentData($uid, $html_text, $overdue_ampel_data_arr);
+						}
+					}
+				}
+				elseif (isError($result_ampel_user))
+				{
+					show_error($result_ampel_user->error);
+				}
+			}
+		}
+		elseif (isError($result_active_ampeln))
+		{
+			show_error($result_active_ampeln->error);
+		}
+
+		// Send mails for new ampeln merged by user
+		foreach ($new_ampel_data_arr as $new_ampel_data)
+		{
+			sendMail(
+				'Sancho_Content_AmpelNeu',
+				$new_ampel_data,
+				$new_ampel_data['uid']. '@'. DOMAIN,
+				'Du hast eine neue Ampel!',
+				'sancho_header_neue_nachrichten_in_ampelsystem.jpg'
+			);
+		};
+		// Send mails for overdue ampeln merged by user
+		foreach ($overdue_ampel_data_arr as $overdue_ampel_data)
+		{
+			sendMail(
+				'Sancho_Content_AmpelUeberfaellig',
+				$overdue_ampel_data,
+				$overdue_ampel_data['uid']. '@'. DOMAIN,
+				'Bestätige bitte Deine Ampel!',
+				'sancho_header_ampel_overdue.jpg'
+			);
+		};
+	}
+	
+	// ------------------------------------------------------------------------
+	// Private methods
+	/**
+	 * Returns associative array with data as needed in the ampel content templates.
+	 * @param string $uid UID, needed to merge user.
+	 * @param string $html_text	Specific HTML Content to be set initially for a user or to add if user exists.
+	 * @param array $ampel_data_arr Array with ampeln.
+	 * @return array
+	 */
+	private function _getAmpelContentData($uid, $html_text, $ampel_data_arr)
+	{
+		$firstName = $this->PersonModel->getByUid($uid)->retval[0]->vorname;
+		
+		// check if user already exists in the array
+		$key_position = array_search($uid, array_column($ampel_data_arr, 'uid'));
+		
+		// If user already exists in the array, add only new ampel data to users ampel list
+		if ($key_position !== false)
+		{
+			$ampel_data_arr[$key_position]['ampel_list'] .= $html_text;
+		}
+		// If user does not exist, create new user and push all data needed
+		else
+		{
+			$ampel_data_arr[] = array(
+				'uid' => $uid,
+				'firstName' => $firstName,
+				'ampel_list' => $html_text,
+				'link' => self::CIS_AMPELVERWALTUNG_URL
+			);
+		}
+		return $ampel_data_arr;
+	}
+}

application/helpers/sancho_helper.php

@@ -0,0 +1,93 @@
+<?php
+/**
+ * FH-Complete
+ *
+ * @package		FHC-Helper
+ * @author		FHC-Team
+ * @copyright	Copyright (c) 2016 fhcomplete.org
+ * @license		GPLv3
+ * @since		Version 1.0.0
+ */
+
+/**
+ * FHC Helper
+ *
+ * @subpackage	Helpers
+ * @category	Helpers
+ */
+
+if (! defined('BASEPATH')) exit('No direct script access allowed');
+
+const DEFAULT_SANCHO_HEADER_IMG = 'sancho_header_du_hast_neue_nachrichten.jpg';
+
+/**
+ * Send single Mail with Sancho Design and Layout.
+ * @param string $vorlage_kurzbz Name of the template for specific mail content.
+ * @param array $vorlage_data Associative array with specific mail content varibales
+ *  to be replaced in the content template.
+ * @param string $to Email-adress.
+ * @param string $subject Subject of mail.
+ * @param string $headerImg	Filename of the specific Sancho header image.
+ * @return void
+ */
+function sendMail($vorlage_kurzbz, $vorlage_data, $to, $subject, $headerImg = DEFAULT_SANCHO_HEADER_IMG)
+{
+	$ci =& get_instance();
+	$ci->load->library('email');
+	$ci->load->library('MailLib');
+	
+	$sanchoHeader_img = 'skin/images/sancho/'. $headerImg;
+	$sanchoFooter_img = 'skin/images/sancho/sancho_footer.jpg';
+
+	// Embed sancho header and footer image
+	// reset important to ensure embedding of images when called in a loop
+	$ci->email->clear(true);  // clear vars and attachments
+	$ci->email->attach($sanchoHeader_img);
+	$ci->email->attach($sanchoFooter_img);
+	$cid_header = $ci->email->attachment_cid($sanchoHeader_img); // sets unique content id for embedding
+	$cid_footer = $ci->email->attachment_cid($sanchoFooter_img); // sets unique content id for embedding
+
+	// Set specific mail content into specific content template
+	$content = _parseMailContent($vorlage_kurzbz, $vorlage_data);
+	
+	// overall main content data array
+	$layout = array(
+		'CID_header' => $cid_header,
+		'CID_footer' => $cid_footer,
+		'content' => $content
+	);
+
+	// Set overall main content into the sancho mail template
+	$body = _parseMailContent('Sancho_Mail_Template', $layout);
+
+	// Send mail
+	$ci->maillib->send('sancho@'. DOMAIN, $to, $subject, $body);
+}
+
+/**
+ * Replace variables in the mail content template with specific mail content data.
+ * @param string $vorlage_kurzbz Name of the template for specific mail content.
+ * @param array $vorlage_data Associative array with specific mail content varibales
+ *  to be replaced in the content template.
+ * @return string
+ */
+function _parseMailContent($vorlage_kurzbz, $vorlage_data)
+{
+	$ci =& get_instance();
+	$ci->load->library('VorlageLib');
+	
+	$result = $ci->vorlagelib->getVorlagetextByVorlage($vorlage_kurzbz);
+
+	if (isSuccess($result))
+	{
+		// If the text and the subject of the template are not empty
+		if (is_array($result->retval) && count($result->retval) > 0 &&
+			!empty($result->retval[0]->text))
+		{
+			// Parses template text
+			$parsedText = $ci->vorlagelib->parseVorlagetext($result->retval[0]->text, $vorlage_data);
+
+			return $parsedText;
+		}
+	}
+}

application/models/content/Ampel_model.php

@@ -1,7 +1,6 @@
 <?php
 class Ampel_model extends DB_Model
 {
-
 	/**
 	 * Constructor
 	 */
@@ -11,4 +10,84 @@ class Ampel_model extends DB_Model
 		$this->dbTable = 'public.tbl_ampel';
 		$this->pk = 'ampel_id';
 	}
+	
+	/**
+	 * Returns all active Ampeln, that are actually:
+	 * 1. not after the deadline date
+	 * 2. not before the vorlaufszeit
+	 * @param bool $email If true, then only ampeln are retrieved that are marked to be sent by mail.
+	 * @return array Returns array of objects.
+	 */
+	public function active($email = false)
+	{
+		$parametersArray = null;
+		$query = '
+			SELECT *
+			  FROM public.tbl_ampel
+			 WHERE';
+		
+		if ($email === true)
+		{
+			$parametersArray['email'] = $email;
+			$query .= ' email = ? AND';
+		}
+		
+		$query .= '
+			(NOW()<(deadline+(verfallszeit || \' days\')::interval)::date)
+			    OR (verfallszeit IS NULL AND NOW() < deadline)
+			   AND (NOW()>(deadline-(vorlaufzeit || \' days\')::interval)::date)
+			    OR (vorlaufzeit IS NULL AND NOW() > deadline)';
+		
+		$query .= ' ORDER BY deadline DESC';
+		
+		return $this->execQuery($query, $parametersArray);
+	}
+	
+	/**
+	 * Returns all Ampel-receiver of a specific Ampel.
+	 * @param string $benutzer_select SQL Statement which defines the Ampel-receiver.
+	 * @return array Returns array of objects with property 'uid'.
+	 */
+	public function execBenutzerSelect($benutzer_select)
+	{
+		if (isset($benutzer_select) && !empty(trim($benutzer_select)))
+		{
+			return $this->execQuery($benutzer_select);
+		}
+	}
+	
+	/**
+	 * Checks if Ampel was confirmed by the user.
+	 * @param int $ampel_id Ampel-ID
+	 * @param string $uid UID
+	 * @return bool
+	 */
+	public function isConfirmed($ampel_id, $uid)
+	{
+		$result = null;
+		$query = '
+			SELECT 1
+			  FROM public.tbl_ampel_benutzer_bestaetigt
+			 WHERE ampel_id = ?
+			   AND uid = ?';
+
+		if (isset($ampel_id, $uid))
+		{
+			$result = $this->execQuery($query, array($ampel_id, $uid));
+		}
+		
+		if ($result)
+		{
+			if (count($result->retval) > 0)
+			{
+				return true;
+			}
+			else
+			{
+				return false;
+			}
+		}
+		else 
+			return $result; //will contain the error-msg from execQuery
+	}
 }