Initial commit

Author: Zsolt Gál

.gitignore

@@ -4,3 +4,4 @@ composer.phar
 # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
 # composer.lock
+.idea/

README.md

@@ -1,2 +1,22 @@
 # php-cli-iterm-image-renderer
 Render images with PHP in your iterm2 console
+
+## usage
+
+```
+#!/usr/bin/env php
+<?php
+
+use Technodelight\ITermImage\Image;
+$image = Image::fromUri('https://picsum.photos/200', 200);
+if (!empty($image)) {
+    echo $image;
+}
+```
+Running the above script will render a random picsum image in your terminal, 200 px wide.
+
+## requirements
+
+This library was built to work with the famous iTerm2 OS X application.
+It has a basic fallback version to render the URI instead of the image, if the current
+iTerm does not support displaying images (or you're not using iTerm2 at all).

composer.json

@@ -0,0 +1,18 @@
+{
+    "name": "technodelight/php-cli-iterm-image-renderer",
+    "description": "Render images with PHP in your iterm2 console",
+    "type": "library",
+    "require": {
+        "technodelight/shell-exec": "^1.0"
+    },
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Zsolt Gál",
+            "email": "zsolt.gal@sessiondigital.com"
+        }
+    ],
+    "autoload": {
+        "PSR-4": {"Technodelight\\ITermImage\\":  "src/"}
+    }
+}

composer.lock

@@ -0,0 +1,43 @@
+<?php
+
+namespace Technodelight\ITermImage;
+
+use Technodelight\ShellExec\Command;
+use Technodelight\ShellExec\Exec;
+
+class ITermVersion
+{
+    private $parsed = false;
+    private $version;
+
+    public function __toString()
+    {
+        return $this->guessVersion();
+    }
+
+    private function guessVersion()
+    {
+        if ($this->parsed) {
+            return $this->version;
+        }
+
+        $this->parsed = true;
+        if ($version = getenv('TERM_PROGRAM_VERSION')) {
+            return $this->version = $version;
+        } else if (is_file('/Applications/iTerm.app/Contents/Info.plist')) {
+            $cmd = Command::create('cat')
+                ->withArgument('/Applications/iTerm.app/Contents/Info.plist')
+                ->pipe(
+                    Command::create('grep')
+                       ->withArgument('CFBundleVersion')
+                       ->withShortOption('A1')
+                );
+            $shell = new Exec();
+            $out = $shell->exec($cmd);
+            $xml = simplexml_load_string('<root>' . join('', $out) . '</root>');
+            return $this->version = (string) $xml->string;
+        }
+
+        return $this->version = '';
+    }
+}

src/ITermVersion.php

@@ -0,0 +1,94 @@
+<?php
+
+namespace Technodelight\ITermImage;
+
+class Image
+{
+    /**
+     * @var string
+     */
+    private $uri;
+    /**
+     * @var string
+     */
+    private $contents;
+    /**
+     * @var int
+     */
+    private $thumbnailWidth;
+    /**
+     * @var ITermVersion
+     */
+    private $itermVersion;
+
+    public static function fromUri($uri, $thumbWidth = 300, ITermVersion $itermVersion = null)
+    {
+        $instance = new self;
+        $instance->uri = $uri;
+        $instance->thumbnailWidth = $thumbWidth;
+        $instance->itermVersion = $itermVersion ?: new ITermVersion;
+
+        return $instance;
+    }
+
+    public static function fromContents($contents, $thumbWidth = 300, ITermVersion $itermVersion = null)
+    {
+        $instance = new self;
+        $instance->contents = $contents;
+        $instance->thumbnailWidth = $thumbWidth;
+        $instance->itermVersion = $itermVersion ?: new ITermVersion;
+
+        return $instance;
+    }
+
+    public function render()
+    {
+        try {
+            if (!$this->isItermCapable()) {
+                return $this->uri;
+            }
+
+            return $this->renderThumbnail($this->getImageContents());
+        } catch (\Exception $e) {
+            return '';
+        }
+    }
+
+    public function __toString()
+    {
+        return $this->render();
+    }
+
+    /**
+     * @return string
+     */
+    protected function getImageContents()
+    {
+        if (!empty($this->contents)) {
+            return $this->contents;
+        }
+
+        return file_get_contents($this->uri);
+    }
+
+    /**
+     * @param $contents
+     * @return string
+     */
+    protected function renderThumbnail($contents)
+    {
+        return chr(27) .
+            ']1337;File=inline=1;width=' . $this->thumbnailWidth . 'px;preserveAspectRatio=1:'
+            . base64_encode($contents)
+            . chr(7);
+    }
+
+    private function isItermCapable()
+    {
+        return version_compare((string) $this->itermVersion, '3.0.0', '>=');
+    }
+
+    private function __construct()
+    {
+    }
+}