Fixed namespaces (PHPCI -> PHPCensor)

src/PHPCensor/Plugin/Email.php

@@ -0,0 +1,245 @@
+<?php
+/**
+ * PHPCI - Continuous Integration for PHP
+ *
+ * @copyright    Copyright 2014, Block 8 Limited.
+ * @license      https://github.com/Block8/PHPCI/blob/master/LICENSE.md
+ * @link         https://www.phptesting.org/
+ */
+
+namespace PHPCensor\Plugin;
+
+use Exception;
+use b8\View;
+use PHPCensor\Builder;
+use PHPCensor\Helper\Lang;
+use PHPCensor\Model\Build;
+use PHPCensor\Helper\Email as EmailHelper;
+use Psr\Log\LogLevel;
+use PHPCensor\Plugin;
+
+/**
+* Email Plugin - Provides simple email capability to PHPCI.
+* @author       Steve Brazier <meadsteve@gmail.com>
+* @package      PHPCI
+* @subpackage   Plugins
+*/
+class Email implements Plugin
+{
+    /**
+     * @var \PHPCI\Builder
+     */
+    protected $phpci;
+
+    /**
+     * @var \PHPCI\Model\Build
+     */
+    protected $build;
+
+    /**
+     * @var array
+     */
+    protected $options;
+
+    /**
+     * Set up the plugin, configure options, etc.
+     * @param Builder $phpci
+     * @param Build   $build
+     * @param array   $options
+     */
+    public function __construct(Builder $phpci, Build $build, array $options = [])
+    {
+        $this->phpci   = $phpci;
+        $this->build   = $build;
+        $this->options = $options;
+
+        $this->phpci->logDebug('Plugin options: ' . json_encode($options));
+    }
+
+    /**
+     * Send a notification mail.
+     */
+    public function execute()
+    {
+        $addresses = $this->getEmailAddresses();
+
+        // Without some email addresses in the yml file then we
+        // can't do anything.
+        if (count($addresses) == 0) {
+            return false;
+        }
+
+        $buildStatus  = $this->build->isSuccessful() ? "Passing Build" : "Failing Build";
+        $projectName  = $this->build->getProject()->getTitle();
+
+        try {
+            $view = $this->getMailTemplate();
+        } catch (Exception $e) {
+            $this->phpci->log(
+                sprintf('Unknown mail template "%s", falling back to default.', $this->options['template']),
+                LogLevel::WARNING
+            );
+            $view = $this->getDefaultMailTemplate();
+        }
+
+        $view->build   = $this->build;
+        $view->project = $this->build->getProject();
+
+        $layout          = new View('Email/layout');
+        $layout->build   = $this->build;
+        $layout->project = $this->build->getProject();
+        $layout->content = $view->render();
+        $body            = $layout->render();
+
+        $sendFailures = $this->sendSeparateEmails(
+            $addresses,
+            sprintf("PHP Censor - %s - %s", $projectName, $buildStatus),
+            $body
+        );
+
+        // This is a success if we've not failed to send anything.
+        $this->phpci->log(Lang::get('n_emails_sent', (count($addresses) - $sendFailures)));
+        $this->phpci->log(Lang::get('n_emails_failed', $sendFailures));
+
+        return ($sendFailures === 0);
+    }
+
+    /**
+     * @param string $toAddress Single address to send to
+     * @param string[] $ccList
+     * @param string $subject Email subject
+     * @param string $body Email body
+     * @return array                      Array of failed addresses
+     */
+    protected function sendEmail($toAddress, $ccList, $subject, $body)
+    {
+        $email = new EmailHelper();
+
+        $email->setEmailTo($toAddress, $toAddress);
+        $email->setSubject($subject);
+        $email->setBody($body);
+        $email->setHtml(true);
+
+        if (is_array($ccList) && count($ccList)) {
+            foreach ($ccList as $address) {
+                $email->addCc($address, $address);
+            }
+        }
+
+        return $email->send($this->phpci);
+    }
+
+    /**
+     * Send an email to a list of specified subjects.
+     *
+     * @param array $toAddresses
+     *   List of destination addresses for message.
+     * @param string $subject
+     *   Mail subject
+     * @param string $body
+     *   Mail body
+     *
+     * @return int number of failed messages
+     */
+    public function sendSeparateEmails(array $toAddresses, $subject, $body)
+    {
+        $failures = 0;
+        $ccList   = $this->getCcAddresses();
+
+        foreach ($toAddresses as $address) {
+            if (!$this->sendEmail($address, $ccList, $subject, $body)) {
+                $failures++;
+            }
+        }
+
+        return $failures;
+    }
+
+    /**
+     * Get the list of email addresses to send to.
+     * @return array
+     */
+    protected function getEmailAddresses()
+    {
+        $addresses = [];
+        $committer = $this->build->getCommitterEmail();
+
+        $this->phpci->logDebug(sprintf("Committer email: '%s'", $committer));
+        $this->phpci->logDebug(sprintf(
+            "Committer option: '%s'",
+            (!empty($this->options['committer']) && $this->options['committer']) ? 'true' : 'false'
+        ));
+
+        if (!empty($this->options['committer']) && $this->options['committer']) {
+            if ($committer) {
+                $addresses[] = $committer;
+            }
+        }
+
+        $this->phpci->logDebug(sprintf(
+            "Addresses option: '%s'",
+            (!empty($this->options['addresses']) && is_array($this->options['addresses'])) ? implode(', ', $this->options['addresses']) : 'false'
+        ));
+
+        if (!empty($this->options['addresses']) && is_array($this->options['addresses'])) {
+            foreach ($this->options['addresses'] as $address) {
+                $addresses[] = $address;
+            }
+        }
+
+        $this->phpci->logDebug(sprintf(
+            "Default mailTo option: '%s'",
+            !empty($this->options['default_mailto_address']) ? $this->options['default_mailto_address'] : 'false'
+        ));
+
+        if (empty($addresses) && !empty($this->options['default_mailto_address'])) {
+            $addresses[] = $this->options['default_mailto_address'];
+        }
+
+        return array_unique($addresses);
+    }
+
+    /**
+     * Get the list of email addresses to CC.
+     *
+     * @return array
+     */
+    protected function getCcAddresses()
+    {
+        $ccAddresses = [];
+
+        if (isset($this->options['cc'])) {
+            foreach ($this->options['cc'] as $address) {
+                $ccAddresses[] = $address;
+            }
+        }
+
+        return $ccAddresses;
+    }
+
+    /**
+     * Get the mail template used to sent the mail.
+     *
+     * @return View
+     */
+    protected function getMailTemplate()
+    {
+        if (isset($this->options['template'])) {
+            return new View('Email/' . $this->options['template']);
+        }
+
+        return $this->getDefaultMailTemplate();
+    }
+
+    /**
+     * Get the default mail template.
+     *
+     * @return View
+     */
+    protected function getDefaultMailTemplate()
+    {
+        $template = $this->build->isSuccessful() ? 'short' : 'long';
+
+        return new View('Email/' . $template);
+    }
+}