Merge pull request #35 from gremo/use-realpath-icon

Use realpath() when setting the notification icon
jolicode · Jun 2, 2017 · f4785d5 · f4785d5
2 parents 84c565c + f277c7b
commit f4785d5
Show file tree

Hide file tree

Showing 10 changed files with 57 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changes between versions
 
+## Not yet released
+
+* Fixed Notification icon to always use a canonical absolute path
+
 ## 1.1.0
 
 * Added NotifierFactory::createOrThrowException() method

diff --git a/src/Notification.php b/src/Notification.php
@@ -88,6 +88,9 @@ public function setIcon($icon)
         // This makes the icon accessible for native commands when it's embedded inside a phar
         if (PharExtractor::isLocatedInsideAPhar($icon)) {
             $icon = PharExtractor::extractFile($icon);
+        } else {
+            // Makes the icon path absolute (expanding all symbolic links and resolving references like "/../")
+            $icon = realpath($icon);
         }
 
         $this->icon = $icon;

diff --git a/tests/NotificationTest.php b/tests/NotificationTest.php
@@ -11,6 +11,8 @@
 
 namespace Joli\JoliNotif\tests;
 
+use Joli\JoliNotif\Notification;
+
 class NotificationTest extends \PHPUnit_Framework_TestCase
 {
     public function testItExtractsIconFromPhar()
@@ -55,4 +57,12 @@ public function testItExtractsIconFromPhar()
         $this->assertTrue(is_file($extractedIconPath));
         $this->assertSame($iconContent, file_get_contents($extractedIconPath));
     }
+
+    public function testItResolvesRealPathToIcon()
+    {
+        $notification = new Notification();
+        $notification->setIcon(__DIR__.'/../tests/fixtures/image.gif');
+
+        $this->assertSame(__DIR__.'/fixtures/image.gif', $notification->getIcon());
+    }
 }
diff --git a/tests/Notifier/CliBasedNotifierTestTrait.php b/tests/Notifier/CliBasedNotifierTestTrait.php
@@ -60,6 +60,8 @@ public function testConfigureProcessAcceptAnyValidNotification(Notification $not
      */
     public function provideValidNotifications()
     {
+        $iconDir = $this->getIconDir();
+
         return [
             [
                 (new Notification())
@@ -75,14 +77,14 @@ public function provideValidNotifications()
             [
                 (new Notification())
                     ->setBody('I\'m the notification body')
-                    ->setIcon('/home/toto/Images/my-icon.png'),
+                    ->setIcon($iconDir.'/image.gif'),
                 $this->getExpectedCommandLineForNotificationWithAnIcon(),
             ],
             [
                 (new Notification())
                     ->setBody('I\'m the notification body')
                     ->setTitle('I\'m the notification title')
-                    ->setIcon('/home/toto/Images/my-icon.png'),
+                    ->setIcon($iconDir.'/image.gif'),
                 $this->getExpectedCommandLineForNotificationWithAllOptions(),
             ],
         ];
@@ -117,6 +119,11 @@ public function testSendThrowsExceptionWhenNotificationHasAnEmptyBody()
         }
     }
 
+    public function getIconDir()
+    {
+        return realpath(dirname(__DIR__).'/fixtures');
+    }
+
     /**
      * @return string
      */

diff --git a/tests/Notifier/GrowlNotifyNotifierTest.php b/tests/Notifier/GrowlNotifyNotifierTest.php
@@ -63,8 +63,10 @@ protected function getExpectedCommandLineForNotificationWithATitle()
      */
     protected function getExpectedCommandLineForNotificationWithAnIcon()
     {
+        $iconDir = $this->getIconDir();
+
         return <<<CLI
-'growlnotify' '--message' 'I'\''m the notification body' '--image' '/home/toto/Images/my-icon.png'
+'growlnotify' '--message' 'I'\''m the notification body' '--image' '${iconDir}/image.gif'
 CLI;
     }
 
@@ -73,8 +75,10 @@ protected function getExpectedCommandLineForNotificationWithAnIcon()
      */
     protected function getExpectedCommandLineForNotificationWithAllOptions()
     {
+        $iconDir = $this->getIconDir();
+
         return <<<CLI
-'growlnotify' '--message' 'I'\''m the notification body' '--title' 'I'\''m the notification title' '--image' '/home/toto/Images/my-icon.png'
+'growlnotify' '--message' 'I'\''m the notification body' '--title' 'I'\''m the notification title' '--image' '${iconDir}/image.gif'
 CLI;
     }
 }
diff --git a/tests/Notifier/NotifuNotifierTest.php b/tests/Notifier/NotifuNotifierTest.php
@@ -64,8 +64,10 @@ protected function getExpectedCommandLineForNotificationWithATitle()
      */
     protected function getExpectedCommandLineForNotificationWithAnIcon()
     {
+        $iconDir = $this->getIconDir();
+
         return <<<CLI
-'notifu' '/m' 'I'\''m the notification body' '/i' '/home/toto/Images/my-icon.png'
+'notifu' '/m' 'I'\''m the notification body' '/i' '${iconDir}/image.gif'
 CLI;
     }
 
@@ -74,8 +76,10 @@ protected function getExpectedCommandLineForNotificationWithAnIcon()
      */
     protected function getExpectedCommandLineForNotificationWithAllOptions()
     {
+        $iconDir = $this->getIconDir();
+
         return <<<CLI
-'notifu' '/m' 'I'\''m the notification body' '/p' 'I'\''m the notification title' '/i' '/home/toto/Images/my-icon.png'
+'notifu' '/m' 'I'\''m the notification body' '/p' 'I'\''m the notification title' '/i' '${iconDir}/image.gif'
 CLI;
     }
 }
diff --git a/tests/Notifier/NotifySendNotifierTest.php b/tests/Notifier/NotifySendNotifierTest.php
@@ -63,8 +63,10 @@ protected function getExpectedCommandLineForNotificationWithATitle()
      */
     protected function getExpectedCommandLineForNotificationWithAnIcon()
     {
+        $iconDir = $this->getIconDir();
+
         return <<<CLI
-'notify-send' '--icon' '/home/toto/Images/my-icon.png' 'I'\''m the notification body'
+'notify-send' '--icon' '${iconDir}/image.gif' 'I'\''m the notification body'
 CLI;
     }
 
@@ -73,8 +75,10 @@ protected function getExpectedCommandLineForNotificationWithAnIcon()
      */
     protected function getExpectedCommandLineForNotificationWithAllOptions()
     {
+        $iconDir = $this->getIconDir();
+
         return <<<CLI
-'notify-send' '--icon' '/home/toto/Images/my-icon.png' 'I'\''m the notification title' 'I'\''m the notification body'
+'notify-send' '--icon' '${iconDir}/image.gif' 'I'\''m the notification title' 'I'\''m the notification body'
 CLI;
     }
 }
diff --git a/tests/Notifier/TerminalNotifierNotifierTest.php b/tests/Notifier/TerminalNotifierNotifierTest.php
@@ -65,8 +65,10 @@ protected function getExpectedCommandLineForNotificationWithATitle()
     protected function getExpectedCommandLineForNotificationWithAnIcon()
     {
         if (OsHelper::isMacOS() && version_compare(OsHelper::getMacOSVersion(), '10.9.0', '>=')) {
+            $iconDir = $this->getIconDir();
+
             return <<<CLI
-'terminal-notifier' '-message' 'I'\''m the notification body' '-appIcon' '/home/toto/Images/my-icon.png'
+'terminal-notifier' '-message' 'I'\''m the notification body' '-appIcon' '${iconDir}/image.gif'
 CLI;
         }
 
@@ -81,8 +83,10 @@ protected function getExpectedCommandLineForNotificationWithAnIcon()
     protected function getExpectedCommandLineForNotificationWithAllOptions()
     {
         if (OsHelper::isMacOS() && version_compare(OsHelper::getMacOSVersion(), '10.9.0', '>=')) {
+            $iconDir = $this->getIconDir();
+
             return <<<CLI
-'terminal-notifier' '-message' 'I'\''m the notification body' '-title' 'I'\''m the notification title' '-appIcon' '/home/toto/Images/my-icon.png'
+'terminal-notifier' '-message' 'I'\''m the notification body' '-title' 'I'\''m the notification title' '-appIcon' '${iconDir}/image.gif'
 CLI;
         }
 

diff --git a/tests/Notifier/ToasterNotifierTest.php b/tests/Notifier/ToasterNotifierTest.php
@@ -64,8 +64,10 @@ protected function getExpectedCommandLineForNotificationWithATitle()
      */
     protected function getExpectedCommandLineForNotificationWithAnIcon()
     {
+        $iconDir = $this->getIconDir();
+
         return <<<CLI
-'toast' '-m' 'I'\''m the notification body' '-p' '/home/toto/Images/my-icon.png'
+'toast' '-m' 'I'\''m the notification body' '-p' '${iconDir}/image.gif'
 CLI;
     }
 
@@ -74,8 +76,10 @@ protected function getExpectedCommandLineForNotificationWithAnIcon()
      */
     protected function getExpectedCommandLineForNotificationWithAllOptions()
     {
+        $iconDir = $this->getIconDir();
+
         return <<<CLI
-'toast' '-m' 'I'\''m the notification body' '-t' 'I'\''m the notification title' '-p' '/home/toto/Images/my-icon.png'
+'toast' '-m' 'I'\''m the notification body' '-t' 'I'\''m the notification title' '-p' '${iconDir}/image.gif'
 CLI;
     }
 }
diff --git a/tests/fixtures/image.gif b/tests/fixtures/image.gif