add more notifiers

src/Console/Prime/FlasherConsole.php

@@ -2,8 +2,15 @@
 
 namespace Flasher\Console\Prime;
 
+use Flasher\Console\Prime\Notifier\GrowlNotifyNotifier;
+use Flasher\Console\Prime\Notifier\KDialogNotifier;
 use Flasher\Console\Prime\Notifier\NotifierInterface;
+use Flasher\Console\Prime\Notifier\NotifuNotifier;
+use Flasher\Console\Prime\Notifier\NotifySendNotifier;
 use Flasher\Console\Prime\Notifier\NullNotifier;
+use Flasher\Console\Prime\Notifier\SnoreToastNotifier;
+use Flasher\Console\Prime\Notifier\TerminalNotifierNotifier;
+use Flasher\Console\Prime\Notifier\ToasterNotifier;
 
 final class FlasherConsole
 {
@@ -12,6 +19,19 @@ final class FlasherConsole
      */
     private $notifiers = array();
 
+    public function __construct()
+    {
+        $this->notifiers = array(
+            new GrowlNotifyNotifier(),
+            new NotifuNotifier(),
+            new TerminalNotifierNotifier(),
+            new SnoreToastNotifier(),
+            new ToasterNotifier(),
+            new NotifySendNotifier(),
+            new KDialogNotifier(),
+        );
+    }
+
     public function render(array $envelopes)
     {
         $notifier = $this->createNotifier();

src/Console/Prime/Notifier/AbstractNotifier.php

@@ -2,6 +2,8 @@
 
 namespace Flasher\Console\Prime\Notifier;
 
+use Flasher\Console\Prime\System\Program;
+use Flasher\Prime\Envelope;
 use Flasher\Prime\Notification\NotificationInterface;
 
 abstract class AbstractNotifier implements NotifierInterface
@@ -13,6 +15,15 @@ abstract class AbstractNotifier implements NotifierInterface
         $this->configureOptions($options);
     }
 
+    public function render(array $envelopes)
+    {
+        foreach ($envelopes as $envelope) {
+            $this->renderEnvelope($envelope);
+        }
+    }
+
+    abstract public function renderEnvelope(Envelope $envelope);
+
     public function isSupported()
     {
         return $this->options['is_supported'];
@@ -28,6 +39,26 @@ abstract class AbstractNotifier implements NotifierInterface
         return $this->options['binary'];
     }
 
+    public function getBinaryPaths()
+    {
+        return $this->options['binary_paths'];
+    }
+
+    public function getProgram()
+    {
+        if (Program::exist($this->getBinary())) {
+            return $this->getBinary();
+        }
+
+        foreach ((array) $this->getBinaryPaths() as $path) {
+            if (file_exists($path)) {
+                return $path;
+            }
+        }
+
+        return null;
+    }
+
     public function getTitle()
     {
         return addslashes($this->options['title']);
@@ -76,6 +107,7 @@ abstract class AbstractNotifier implements NotifierInterface
             'enabled' => true,
             'priority' => 0,
             'binary' => null,
+            'binary_paths' => array(),
             'title' => 'PHPFlasher',
             'icons' => array(
                 NotificationInterface::TYPE_SUCCESS => __DIR__ . '/../Resources/icons/success.png',

src/Console/Prime/Notifier/GrowlNotifyNotifier.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Flasher\Console\Prime\Notifier;
+
+use Flasher\Console\Prime\System\Command;
+use Flasher\Console\Prime\System\OS;
+use Flasher\Prime\Envelope;
+
+final class GrowlNotifyNotifier extends AbstractNotifier
+{
+    public function renderEnvelope(Envelope $envelope)
+    {
+        $cmd = new Command($this->getProgram());
+
+        $cmd
+            ->addOption('--message', $envelope->getMessage())
+            ->addOption('--title', $this->getTitle())
+            ->addOption('--image', $this->getIcon($envelope->getType()))
+        ;
+
+        $cmd->run();
+    }
+
+    public function isSupported()
+    {
+        return $this->isEnabled() && OS::isMacOS() && $this->getProgram();
+    }
+
+    public function configureOptions(array $options)
+    {
+        $default = array(
+            'binary' => 'growlnotify',
+        );
+
+        $options = array_replace($default, $options);
+
+        parent::configureOptions($options);
+    }
+}

src/Console/Prime/Notifier/KDialogNotifier.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Flasher\Console\Prime\Notifier;
+
+use Flasher\Console\Prime\System\Command;
+use Flasher\Console\Prime\System\OS;
+use Flasher\Prime\Envelope;
+
+final class KDialogNotifier extends AbstractNotifier
+{
+    public function renderEnvelope(Envelope $envelope)
+    {
+        $cmd = new Command($this->getProgram());
+
+        $cmd
+            ->addOption('--passivepopup', $envelope->getMessage())
+            ->addOption('--title', $this->getTitle())
+            ->addArgument(5)
+        ;
+
+        $cmd->run();
+    }
+
+    public function isSupported()
+    {
+        return $this->isEnabled() && OS::isUnix() && $this->getProgram();
+    }
+
+    public function configureOptions(array $options)
+    {
+        $default = array(
+            'binary' => 'kdialog',
+        );
+
+        $options = array_replace($default, $options);
+
+        parent::configureOptions($options);
+    }
+}

src/Console/Prime/Notifier/NotifierInterface.php

@@ -9,7 +9,7 @@ interface NotifierInterface
     /**
      * @param Envelope[] $envelopes
      */
-    public function render(array $envelopes, $firstTime = true);
+    public function render(array $envelopes);
 
     /**
      * @return bool

src/Console/Prime/Notifier/NotifuNotifier.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Flasher\Console\Prime\Notifier;
+
+use Flasher\Console\Prime\System\Command;
+use Flasher\Console\Prime\System\OS;
+use Flasher\Prime\Envelope;
+
+final class NotifuNotifier extends AbstractNotifier
+{
+    public function renderEnvelope(Envelope $envelope)
+    {
+        $cmd = new Command($this->getProgram());
+
+        $cmd
+            ->addOption('/m', $envelope->getMessage())
+            ->addOption('/p', $this->getTitle())
+            ->addOption('/i', $this->getIcon($envelope->getType()))
+            ->addArgument(5)
+        ;
+
+        $cmd->run();
+    }
+
+    public function isSupported()
+    {
+        return $this->isEnabled() && OS::isWindows() && $this->getProgram();
+    }
+
+    public function configureOptions(array $options)
+    {
+        $default = array(
+            'binary' => 'notifu',
+            'binary_paths' => array(
+                __DIR__ . '/../Resources/bin/notifu/notifu.exe',
+            ),
+        );
+
+        $options = array_replace($default, $options);
+
+        parent::configureOptions($options);
+    }
+}

src/Console/Prime/Notifier/NotifySendNotifier.php

@@ -2,45 +2,31 @@
 
 namespace Flasher\Console\Prime\Notifier;
 
+use Flasher\Console\Prime\System\Command;
+use Flasher\Console\Prime\System\OS;
 use Flasher\Prime\Envelope;
 
 final class NotifySendNotifier extends AbstractNotifier
 {
-    public function render(array $envelopes, $firstTime = true)
-    {
-        if ($firstTime) {
-            $this->playSound();
-        }
-
-        foreach ($envelopes as $envelope) {
-            $this->renderEnvelope($envelope);
-        }
-    }
-
     public function renderEnvelope(Envelope $envelope)
     {
-        $cmd = $this->getBinary();
+        $cmd = new Command($this->getProgram());
 
-        $cmd .= ' --urgency="normal"';
-        $cmd .= ' --app-name="notify"';
-        $cmd .= ' --icon="'.$this->getIcon($envelope->getType()).'"';
-        $cmd .= ' --expire-time=' . $this->getExpireTime();
-        $cmd .= ' "' . $this->getTitle() . '"';
-        $cmd .= ' "' . addslashes($envelope->getMessage()) . '"';
+        $cmd
+            ->addOption('--urgency', 'normal')
+            ->addOption('--app-name', 'notify')
+            ->addOption('--icon', $this->getIcon($envelope->getType()))
+            ->addOption('--expire-time', $this->getExpireTime())
+            ->addArgument($this->getTitle())
+            ->addArgument($envelope->getMessage())
+        ;
 
-        \exec($cmd);
+        $cmd->run();
     }
 
     public function isSupported()
     {
-        return $this->isEnabled() && in_array(PHP_OS, array(
-            'Linux',
-            'FreeBSD',
-            'NetBSD',
-            'OpenBSD',
-            'SunOS',
-            'DragonFly',
-        ));
+        return $this->isEnabled() && OS::isUnix() && $this->getProgram();
     }
 
     public function getExpireTime()

src/Console/Prime/Notifier/NullNotifier.php

@@ -2,9 +2,11 @@
 
 namespace Flasher\Console\Prime\Notifier;
 
+use Flasher\Prime\Envelope;
+
 final class NullNotifier extends AbstractNotifier
 {
-    public function render(array $envelopes, $firstTime = true)
+    public function renderEnvelope(Envelope $envelope)
     {
     }
 

src/Console/Prime/Notifier/SnoreToastNotifier.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Flasher\Console\Prime\Notifier;
+
+use Flasher\Console\Prime\System\Command;
+use Flasher\Console\Prime\System\OS;
+use Flasher\Prime\Envelope;
+
+final class SnoreToastNotifier extends AbstractNotifier
+{
+    public function renderEnvelope(Envelope $envelope)
+    {
+        $cmd = new Command($this->getProgram());
+
+        $cmd
+            ->addOption('-m', $envelope->getMessage())
+            ->addOption('-t', $this->getTitle())
+            ->addOption('-p', $this->getIcon($envelope->getType()))
+        ;
+
+        $cmd->run();
+    }
+
+    public function isSupported()
+    {
+        return $this->isEnabled() && OS::isWindows() && $this->getProgram();
+    }
+
+    public function configureOptions(array $options)
+    {
+        $default = array(
+            'binary' => 'snoretoast',
+            'binary_paths' => array(
+                __DIR__ . '/../Resources/bin/snoreToast/snoretoast-x86.exe',
+            ),
+        );
+
+        $options = array_replace($default, $options);
+
+        parent::configureOptions($options);
+    }
+}

src/Console/Prime/Notifier/TerminalNotifierNotifier.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Flasher\Console\Prime\Notifier;
+
+use Flasher\Console\Prime\System\Command;
+use Flasher\Console\Prime\System\OS;
+use Flasher\Prime\Envelope;
+
+final class TerminalNotifierNotifier extends AbstractNotifier
+{
+    public function renderEnvelope(Envelope $envelope)
+    {
+        $cmd = new Command($this->getProgram());
+
+        $cmd
+            ->addOption('-message', $envelope->getMessage())
+            ->addOption('-title', $this->getTitle())
+            ->addOption('-appIcon', $this->getIcon($envelope->getType()))
+        ;
+
+        $cmd->run();
+    }
+
+    public function isSupported()
+    {
+        return $this->isEnabled() && OS::isMacOS() && $this->getProgram();
+    }
+
+    public function configureOptions(array $options)
+    {
+        $default = array(
+            'binary' => 'terminal-notifier',
+        );
+
+        $options = array_replace($default, $options);
+
+        parent::configureOptions($options);
+    }
+}

src/Console/Prime/Notifier/ToasterNotifier.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Flasher\Console\Prime\Notifier;
+
+use Flasher\Console\Prime\System\Command;
+use Flasher\Console\Prime\System\OS;
+use Flasher\Prime\Envelope;
+
+final class ToasterNotifier extends AbstractNotifier
+{
+    public function renderEnvelope(Envelope $envelope)
+    {
+        $cmd = new Command($this->getProgram());
+
+        $cmd
+            ->addOption('-m', $envelope->getMessage())
+            ->addOption('-t', $this->getTitle())
+            ->addOption('-p', $this->getIcon($envelope->getType()))
+        ;
+
+        $cmd->run();
+    }
+
+    public function isSupported()
+    {
+        return $this->isEnabled() && OS::isWindows() && $this->getProgram();
+    }
+
+    public function configureOptions(array $options)
+    {
+        $default = array(
+            'binary' => 'toast',
+            'binary_paths' => array(
+                __DIR__ . '/../Resources/bin/toaster/toast.exe',
+            ),
+        );
+
+        $options = array_replace($default, $options);
+
+        parent::configureOptions($options);
+    }
+}

src/Console/Prime/Resources/bin/notifu/README.md

@@ -0,0 +1,7 @@
+# Notifu
+
+This binary come from the [Notifu](http://www.paralint.com/projects/notifu)
+project. All credits for this Windows tool goes to their original authors.
+
+Only the required file was extracted here. If you want to fully test it, please
+have a look at [this url](http://www.paralint.com/projects/notifu) instead.

src/Console/Prime/Resources/bin/snoreToast/LICENSE

@@ -0,0 +1,166 @@
+// Retrieved from https://github.com/KDE/snoretoast/blob/master/COPYING.LGPL-3 version 0.7.0
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

src/Console/Prime/Resources/bin/snoreToast/README.md

@@ -0,0 +1,7 @@
+# SnoreToast
+
+These toaster binary files come from the [KDE/snoretoast](https://github.com/KDE/snoretoast)
+project. All credits for this Windows 8* application goes to [KDE project](https://github.com/KDE).
+
+Only the required files were extracted here. If you want to fully test it,
+please have a look at the github project instead.

src/Console/Prime/Resources/bin/toaster/README.md

@@ -0,0 +1,7 @@
+# Toaster
+
+These toaster binary files come from the [nels-o/toaster](https://github.com/nels-o/toaster)
+project. All credits for this Windows 8 application goes to [nels-o](https://github.com/nels-o).
+
+Only the required files were extracted here. If you want to fully test it,
+please have a look at the github project instead.

src/Console/Prime/System/Command.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Flasher\Console\Prime\System;
+
+class Command
+{
+    private $command;
+    private $options = array();
+    private $arguments = array();
+    private $output;
+    private $exitCode;
+
+    public function __construct($command)
+    {
+        $this->command = escapeshellcmd($command);
+    }
+
+    public function addOption($name, $value = null)
+    {
+        $this->options[$name] = escapeshellarg($value);
+
+        return $this;
+    }
+
+    public function addArgument($argument)
+    {
+        $this->arguments[] = escapeshellarg($argument);
+
+        return $this;
+    }
+
+    public function run()
+    {
+        exec($this->command . ' ' . $this->formatOptions() . ' ' . $this->formatArguments(), $this->output, $this->exitCode);
+    }
+
+    private function formatArguments()
+    {
+        return implode(' ', $this->arguments);
+    }
+
+    private function formatOptions()
+    {
+        $line = '';
+
+        foreach ($this->options as $name => $value) {
+            $line .= $name;
+            if ($value) {
+                $line .= '='.$value.' ';
+            }
+        }
+
+        return $line;
+    }
+
+    public function getOutput()
+    {
+        return $this->output;
+    }
+
+    public function getExitCode()
+    {
+        return $this->exitCode;
+    }
+
+    public function isSuccessful()
+    {
+        return 0 === $this->getExitCode();
+    }
+}

src/Console/Prime/System/OS.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Flasher\Console\Prime\System;
+
+class OS
+{
+    public static function getName()
+    {
+        return php_uname('s');
+    }
+
+    public static function getRelease()
+    {
+        return php_uname('r');
+    }
+
+    public static function isUnix()
+    {
+        return in_array(self::getName(), array(
+            'Linux',
+            'FreeBSD',
+            'NetBSD',
+            'OpenBSD',
+            'SunOS',
+            'DragonFly',
+        ));
+    }
+
+    public static function isWindows()
+    {
+        return 'WIN' === strtoupper(substr(self::getName(), 0, 3));
+    }
+
+    public static function isWindowsSeven()
+    {
+        return self::isWindows() && '6.1' === self::getRelease();
+    }
+
+    public static function isWindowsEightOrHigher()
+    {
+        return self::isWindows() && version_compare(self::getRelease(), '6.2', '>=');
+    }
+
+    public static function isWindowsSubsystemForLinux()
+    {
+        return self::isUnix() && false !== mb_strpos(strtolower(self::getName()), 'microsoft');
+    }
+
+    public static function isMacOS()
+    {
+        return false !== strpos(self::getName(), 'Darwin');
+    }
+}

src/Console/Prime/System/Program.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Flasher\Console\Prime\System;
+
+class Program
+{
+    public static function exist($program)
+    {
+        if (OS::isWindows()) {
+            $output = shell_exec("where $program");
+
+            return !empty($output);
+        }
+
+        $output = shell_exec("command -v $program");
+
+        return !empty($output);
+    }
+}