Updated to Drupal 8.5. Core Media not yet in use.

[yaffs-website] / vendor / drush / drush / src / Commands / core / NotifyCommands.php

diff --git a/vendor/drush/drush/src/Commands/core/NotifyCommands.php b/vendor/drush/drush/src/Commands/core/NotifyCommands.php
new file mode 100644 (file)
index 0000000..beb49a7
--- /dev/null
+++ b/vendor/drush/drush/src/Commands/core/NotifyCommands.php
@@ -0,0 +1,115 @@
+<?php
+namespace Drush\Commands\core;
+
+use Consolidation\AnnotatedCommand\CommandData;
+use Drush\Commands\DrushCommands;
+use Drush\Drush;
+use Symfony\Component\Config\Definition\Exception\Exception;
+use Webmozart\PathUtil\Path;
+
+class NotifyCommands extends DrushCommands
+{
+    /**
+     * @hook option *
+     * @option notify Notify upon command completion. If set to a number, commands that finish in fewer seconds won't notify.
+     */
+    public function optionsetNotify()
+    {
+    }
+
+    /**
+     * @hook pre-command *
+     */
+    public function registerShutdown(CommandData $commandData)
+    {
+        register_shutdown_function([$this, 'shutdown'], $commandData);
+    }
+
+    public function shutdown(CommandData $commandData)
+    {
+
+        $annotationData = $commandData->annotationData();
+        if (!$cmd = $annotationData['command']) {
+            return;
+        }
+
+        if (Drush::config()->get('notify.duration')) {
+            if (self::isAllowed($commandData)) {
+                $msg = dt("Command '!command' completed.", ['!command' => $cmd]);
+                self::shutdownSend($msg, $commandData);
+            }
+        }
+    }
+
+    /**
+     * Prepares and dispatches notifications to delivery mechanisms.
+     *
+     * You may avoid routing a message to secondary messaging mechanisms (e.g. audio),
+     * by direct use of the delivery functions.
+     *
+     * @param string $msg
+     *   Message to send via notification.
+     */
+    public static function shutdownSend($msg, CommandData $commandData)
+    {
+        self::shutdownSendText($msg, $commandData);
+    }
+
+    /**
+     * Send text-based system notification.
+     *
+     * This is the automatic, default behavior. It is intended for use with tools
+     * such as libnotify in Linux and Notification Center on OSX.
+     *
+     * @param string $msg
+     *   Message text for delivery.
+     *
+     * @return bool
+     *   TRUE on success, FALSE on failure
+     */
+    public static function shutdownSendText($msg, CommandData $commandData)
+    {
+        $override = Drush::config()->get('notify.cmd');
+
+        if (!empty($override)) {
+            $cmd = $override;
+        } else {
+            switch (PHP_OS) {
+                case 'Darwin':
+                    $cmd = 'terminal-notifier -message %s -title Drush';
+                    $error_message = dt('terminal-notifier command failed. Please install it from https://github.com/alloy/terminal-notifier.');
+                    break;
+                case 'Linux':
+                default:
+                    $icon = Path::join(DRUSH_BASE_PATH, 'drush_logo-black.png');
+                    $cmd = "notify-send %s -i $icon";
+                    $error_message = dt('notify-send command failed. Please install it as per http://coderstalk.blogspot.com/2010/02/how-to-install-notify-send-in-ubuntu.html.');
+                    break;
+            }
+        }
+
+        if (!drush_shell_exec($cmd, $msg)) {
+            throw new \Exception($error_message . ' ' . dt('Or you may specify an alternate command to run by setting notify:cmd in a drush.yml file'));
+        }
+
+        return true;
+    }
+
+    /**
+     * Identify if the given Drush request should trigger a notification.
+     *
+     * @param $command
+     *   Name of the command.
+     *
+     * @return
+     *   Boolean
+     */
+    public static function isAllowed(CommandData $commandData)
+    {
+        $duration = Drush::config()->get('notify.duration');
+        $execution = time() - $_SERVER['REQUEST_TIME'];
+
+        return ($duration === true ||
+        (is_numeric($duration) && $duration > 0 && $execution > $duration));
+    }
+}