Drush: commands/core/notify.drush.inc Source File

  1. 7.x doxygen/html/notify_8drush_8inc_source.html
  2. master doxygen/html/notify_8drush_8inc_source.html
Go to the documentation of this file.
1 <?php
2 /**
3  * @file
4  * Add system notifications as a new drush option.
5  */
6 
7 /**
8  * @todo there are no hooks fired after a command errors out.
9  */
10 register_shutdown_function('drush_notify_shutdown_error');
11 
12 /**
13  * Implements hook_drush_help_alter().
14  */
15 function notify_drush_help_alter(&$command) {
16  if ($command['command'] == 'global-options') {
17  // Do not include these in options in standard help.
18  if ($command['#brief'] === FALSE) {
19  $command['options']['notify'] = array(
20  'description' => 'Use system notifications to signal command completion. If set to a number, commands that finish in fewer seconds will not trigger a notification.',
21  'example-value' => 60,
22  );
23  $command['options']['notify-audio'] = array(
24  'description' => 'Trigger an audio alert to signal command completion. If set to a number, commands that finish in fewer seconds will not trigger a notification.',
25  'example-value' => 60,
26  );
27  $command['sub-options']['notify']['notify-cmd'] = 'Specify the shell command to trigger the notification.';
28  $command['sub-options']['notify']['notify-cmd-audio'] = 'Specify the shell command to trigger the audio notification.';
29  }
30  }
31 }
32 
33 /**
34  * Implements hook_drush_help().
35  */
36 function notify_drush_help($section) {
37  switch ($section) {
38  case 'notify:cache-clear':
39  return dt('Caches have been cleared.');
40  case 'notify:site-install:error':
41  return dt('Failed on site installation');
42  }
43 }
44 
45 /**
46  * Implements hook_drush_exit().
47  */
48 function notify_drush_exit() {
49  $cmd = drush_get_command();
50  // pm-download handles its own notification.
51  if ($cmd['command'] != 'pm-download' && drush_notify_allowed($cmd['command'])) {
52  $msg = dt("Command '!command' completed.", array('!command' => $cmd['command']));
53  drush_notify_send(drush_notify_command_message($cmd['command'], $msg));
54  }
55 }
56 
57 /**
58  * Shutdown function to signal on errors.
59  */
61  if (drush_get_option('notify', FALSE) && drush_get_error()) {
62  // If the only error is that notify failed, do not try to notify again.
63  $log = drush_get_error_log();
64  if (count($log) == 1 && array_key_exists('NOTIFY_COMMAND_NOT_FOUND', $log)) {
65  return;
66  }
67 
68  // Send an alert that the command failed.
69  $cmd = drush_get_command();
70  if (drush_notify_allowed($cmd['command'])) {
71  $msg = dt("Command '!command' failed.", array('!command' => $cmd['command']));
72  drush_notify_send(drush_notify_command_message($cmd['command'] . ':error', $msg));
73  }
74  }
75 }
76 
77 /**
78  * Determine the message to send on command completion.
79  *
80  * @param string $command
81  * Name of the Drush command for which we check message overrides.
82  * @param string $default
83  * (Default: NULL) Default message to use if there are not notification message overrides.
84  *
85  * @return string
86  * Message to use for notification.
87  */
88 function drush_notify_command_message($command, $default = NULL) {
89  if ($msg = drush_command_invoke_all('drush_help', 'notify:' . $command)) {
90  $msg = implode("\n", $msg);
91  }
92  else {
93  $msg = $default ? $default : $msg = $command . ': No news is good news.';
94  }
95 
96  return $msg;
97 }
98 
99 /**
100  * Prepares and dispatches notifications to delivery mechanisms.
101  *
102  * You may avoid routing a message to secondary messaging mechanisms (e.g. audio),
103  * by direct use of the delivery functions.
104  *
105  * @param string $msg
106  * Message to send via notification.
107  */
108 function drush_notify_send($msg) {
110  if (drush_get_option('notify-audio', FALSE)) {
112  }
113 }
114 
115 /**
116  * Send text-based system notification.
117  *
118  * This is the automatic, default behavior. It is intended for use with tools
119  * such as libnotify in Linux and Notification Center on OSX.
120  *
121  * @param string $msg
122  * Message text for delivery.
123  *
124  * @return bool
125  * TRUE on success, FALSE on failure
126  */
127 function drush_notify_send_text($msg) {
128  $override = drush_get_option('notify-cmd', FALSE);
129 
130  if (!empty($override)) {
131  $cmd = $override;
132  }
133  else {
134  switch (PHP_OS) {
135  case 'Darwin':
136  $cmd = 'terminal-notifier -message %s -title Drush';
137  $error_message = dt('terminal-notifier command failed. Please install it from https://github.com/alloy/terminal-notifier.');
138  break;
139  case 'Linux':
140  default:
141  $icon = drush_normalize_path(DRUSH_BASE_PATH . '/drush_logo-black.png');
142  $cmd = "notify-send %s -i $icon";
143  $error_message = dt('notify-send command failed. Please install it as per http://coderstalk.blogspot.com/2010/02/how-to-install-notify-send-in-ubu...);
144  break;
145  }
146  }
147 
148  if (!drush_shell_exec($cmd, $msg)) {
149  return drush_set_error('NOTIFY_COMMAND_NOT_FOUND', $error_message . ' ' . dt('Or you may specify an alternate command to run by specifying --notify-cmd=<my_command>'));
150  }
151 
152  return TRUE;
153 }
154 
155 /**
156  * Send an audio-based system notification.
157  *
158  * This function is only automatically invoked with the additional use of the
159  * --notify-audio flag or configuration state.
160  *
161  * @param $msg
162  * Message for audio recital.
163  *
164  * @return bool
165  * TRUE on success, FALSE on failure
166  */
167 function drush_notify_send_audio($msg) {
168  $override = drush_get_option('notify-cmd-audio', FALSE);
169 
170  if (!empty($override)) {
171  $cmd = $override;
172  }
173  else {
174  switch (PHP_OS) {
175  case 'Darwin':
176  $cmd = 'say %s';
177  break;
178  case 'Linux':
179  default:
180  $cmd = drush_get_option('notify-cmd-audio', 'spd-say') . ' %s';
181  }
182  }
183 
184  if (!drush_shell_exec($cmd, $msg)) {
185  return drush_set_error('NOTIFY_COMMAND_NOT_FOUND', dt('The third party notification utility failed.'));
186  }
187 }
188 
189 /**
190  * Identify if the given Drush request should trigger a notification.
191  *
192  * @param $command
193  * Name of the command.
194  *
195  * @return
196  * Boolean
197  */
198 function drush_notify_allowed($command) {
199  $notify = drush_get_option(array('notify', 'notify-audio'), FALSE);
200  $execution = time() - $_SERVER['REQUEST_TIME'];
201 
202  return ($notify === TRUE ||
203  (is_numeric($notify) && $notify > 0 && $execution > $notify));
204 }
205 

File

doxygen/html/notify_8drush_8inc_source.html
View source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Drush: commands/core/notify.drush.inc Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Drush
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_afac61274991793aa7e9133a8f4f291e.html">commands</a></li><li class="navelem"><a class="el" href="dir_5762b63965e3a68a35f77c23b4dd4668.html">core</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">notify.drush.inc</div>  </div>
</div><!--header-->
<div class="contents">
<a href="notify_8drush_8inc.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;&lt;?php<span class="comment"></span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * @file</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Add system notifications as a new drush option.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * @todo there are no hooks fired after a command errors out.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;register_shutdown_function(<span class="stringliteral">&#39;drush_notify_shutdown_error&#39;</span>);</div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * Implements hook_drush_help_alter().</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="code" href="notify_8drush_8inc.html#ac17569989198f84547afc0089295029c">   15</a></span>&#160;<span class="keyword">function</span> <a class="code" href="notify_8drush_8inc.html#ac17569989198f84547afc0089295029c">notify_drush_help_alter</a>(&amp;$command) {</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;  <span class="keywordflow">if</span> ($command[<span class="stringliteral">&#39;command&#39;</span>] == <span class="stringliteral">&#39;global-options&#39;</span>) {</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;    <span class="comment">// Do not include these in options in standard help.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;    <span class="keywordflow">if</span> ($command[<span class="stringliteral">&#39;#brief&#39;</span>] === FALSE) {</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;      $command[<span class="stringliteral">&#39;options&#39;</span>][<span class="stringliteral">&#39;notify&#39;</span>] = array(</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;        <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Use system notifications to signal command completion. If set to a number, commands that finish in fewer seconds will not trigger a notification.&#39;</span>,</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;        <span class="stringliteral">&#39;example-value&#39;</span> =&gt; 60,</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;      );</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;      $command[<span class="stringliteral">&#39;options&#39;</span>][<span class="stringliteral">&#39;notify-audio&#39;</span>] = array(</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;        <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Trigger an audio alert to signal command completion. If set to a number, commands that finish in fewer seconds will not trigger a notification.&#39;</span>,</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;        <span class="stringliteral">&#39;example-value&#39;</span> =&gt; 60,</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;      );</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;      $command[<span class="stringliteral">&#39;sub-options&#39;</span>][<span class="stringliteral">&#39;notify&#39;</span>][<span class="stringliteral">&#39;notify-cmd&#39;</span>] = <span class="stringliteral">&#39;Specify the shell command to trigger the notification.&#39;</span>;</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;      $command[<span class="stringliteral">&#39;sub-options&#39;</span>][<span class="stringliteral">&#39;notify&#39;</span>][<span class="stringliteral">&#39;notify-cmd-audio&#39;</span>] = <span class="stringliteral">&#39;Specify the shell command to trigger the audio notification.&#39;</span>;</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    }</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;  }</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;}</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"> * Implements hook_drush_help().</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="code" href="notify_8drush_8inc.html#a0a593fa097521030d922735b236c3e7a">   36</a></span>&#160;<span class="keyword">function</span> <a class="code" href="notify_8drush_8inc.html#a0a593fa097521030d922735b236c3e7a">notify_drush_help</a>($section) {</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;  <span class="keywordflow">switch</span> ($section) {</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <span class="keywordflow">case</span> <span class="stringliteral">&#39;notify:cache-clear&#39;</span>:</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;      <span class="keywordflow">return</span> <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Caches have been cleared.&#39;</span>);</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <span class="keywordflow">case</span> <span class="stringliteral">&#39;notify:site-install:error&#39;</span>:</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;      <span class="keywordflow">return</span> <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Failed on site installation&#39;</span>);</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;  }</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;}</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment"> * Implements hook_drush_exit().</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="code" href="notify_8drush_8inc.html#aa3b05a4a16083977b8616c2404a045fc">   48</a></span>&#160;<span class="keyword">function</span> <a class="code" href="notify_8drush_8inc.html#aa3b05a4a16083977b8616c2404a045fc">notify_drush_exit</a>() {</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  $cmd = <a class="code" href="context_8inc.html#a8fc57227375a540fea5314b154576354">drush_get_command</a>();</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  <span class="comment">// pm-download handles its own notification.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  <span class="keywordflow">if</span> ($cmd[<span class="stringliteral">&#39;command&#39;</span>] != <span class="stringliteral">&#39;pm-download&#39;</span> &amp;&amp; <a class="code" href="notify_8drush_8inc.html#a164c0fa71b4c3c581b887c130da76f6b">drush_notify_allowed</a>($cmd[<span class="stringliteral">&#39;command&#39;</span>])) {</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    $msg = <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;Command &#39;!command&#39; completed.&quot;</span>, array(<span class="stringliteral">&#39;!command&#39;</span> =&gt; $cmd[<span class="stringliteral">&#39;command&#39;</span>]));</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <a class="code" href="notify_8drush_8inc.html#a019c8116bcc63e1577cf6b5dec3ec24e">drush_notify_send</a>(<a class="code" href="notify_8drush_8inc.html#a17c65f5ac8c57166084cdbd157b28782">drush_notify_command_message</a>($cmd[<span class="stringliteral">&#39;command&#39;</span>], $msg));</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;  }</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;}</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> * Shutdown function to signal on errors.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="code" href="notify_8drush_8inc.html#af572d593a2ac7c62058eccf211751d45">   60</a></span>&#160;<span class="keyword">function</span> <a class="code" href="notify_8drush_8inc.html#af572d593a2ac7c62058eccf211751d45">drush_notify_shutdown_error</a>() {</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;  <span class="keywordflow">if</span> (<a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;notify&#39;</span>, FALSE) &amp;&amp; <a class="code" href="group__errorhandling.html#ga33fe8456b3dc49a0e28e7f63692a0d44">drush_get_error</a>()) {</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="comment">// If the only error is that notify failed, do not try to notify again.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    $log = <a class="code" href="group__errorhandling.html#gaf64f258413d1fed041c634581e39bff0">drush_get_error_log</a>();</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keywordflow">if</span> (count($log) == 1 &amp;&amp; array_key_exists(<span class="stringliteral">&#39;NOTIFY_COMMAND_NOT_FOUND&#39;</span>, $log)) {</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;      <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    }</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    <span class="comment">// Send an alert that the command failed.</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    $cmd = <a class="code" href="context_8inc.html#a8fc57227375a540fea5314b154576354">drush_get_command</a>();</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <span class="keywordflow">if</span> (<a class="code" href="notify_8drush_8inc.html#a164c0fa71b4c3c581b887c130da76f6b">drush_notify_allowed</a>($cmd[<span class="stringliteral">&#39;command&#39;</span>])) {</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;      $msg = <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;Command &#39;!command&#39; failed.&quot;</span>, array(<span class="stringliteral">&#39;!command&#39;</span> =&gt; $cmd[<span class="stringliteral">&#39;command&#39;</span>]));</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;      <a class="code" href="notify_8drush_8inc.html#a019c8116bcc63e1577cf6b5dec3ec24e">drush_notify_send</a>(<a class="code" href="notify_8drush_8inc.html#a17c65f5ac8c57166084cdbd157b28782">drush_notify_command_message</a>($cmd[<span class="stringliteral">&#39;command&#39;</span>] . <span class="stringliteral">&#39;:error&#39;</span>, $msg));</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    }</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;  }</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;}</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"> * Determine the message to send on command completion.</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment"> * @param string $command</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"> *   Name of the Drush command for which we check message overrides.</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"> * @param string $default</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment"> *   (Default: NULL) Default message to use if there are not notification message overrides.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment"> * @return string</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment"> *   Message to use for notification.</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="code" href="notify_8drush_8inc.html#a17c65f5ac8c57166084cdbd157b28782">   88</a></span>&#160;<span class="keyword">function</span> <a class="code" href="notify_8drush_8inc.html#a17c65f5ac8c57166084cdbd157b28782">drush_notify_command_message</a>($command, $default = NULL) {</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;  <span class="keywordflow">if</span> ($msg = <a class="code" href="includes_2command_8inc.html#a19eba9666aba673a64fbd78a2c5ef4f9">drush_command_invoke_all</a>(<span class="stringliteral">&#39;drush_help&#39;</span>, <span class="stringliteral">&#39;notify:&#39;</span> . $command)) {</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    $msg = implode(<span class="stringliteral">&quot;\n&quot;</span>, $msg);</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;  }</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    $msg = $default ? $default : $msg = $command . <span class="stringliteral">&#39;: No news is good news.&#39;</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;  }</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;  <span class="keywordflow">return</span> $msg;</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;}</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment"> * Prepares and dispatches notifications to delivery mechanisms.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment"> * You may avoid routing a message to secondary messaging mechanisms (e.g. audio),</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"> * by direct use of the delivery functions.</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"> * @param string $msg</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment"> *   Message to send via notification.</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"><a class="code" href="notify_8drush_8inc.html#a019c8116bcc63e1577cf6b5dec3ec24e">  108</a></span>&#160;<span class="keyword">function</span> <a class="code" href="notify_8drush_8inc.html#a019c8116bcc63e1577cf6b5dec3ec24e">drush_notify_send</a>($msg) {</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;  <a class="code" href="notify_8drush_8inc.html#a671bf218a111ec39d0f0fc2919e64daf">drush_notify_send_text</a>($msg);</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;  <span class="keywordflow">if</span> (<a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;notify-audio&#39;</span>, FALSE)) {</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    <a class="code" href="notify_8drush_8inc.html#a1cf454258746f8e8a83c5fa9b9a91426">drush_notify_send_audio</a>($msg);</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;  }</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;}</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment"> * Send text-based system notification.</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment"> * This is the automatic, default behavior. It is intended for use with tools</span></div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment"> * such as libnotify in Linux and Notification Center on OSX.</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment"> * @param string $msg</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"> *   Message text for delivery.</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"> * @return bool</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment"> *   TRUE on success, FALSE on failure</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"><a class="code" href="notify_8drush_8inc.html#a671bf218a111ec39d0f0fc2919e64daf">  127</a></span>&#160;<span class="keyword">function</span> <a class="code" href="notify_8drush_8inc.html#a671bf218a111ec39d0f0fc2919e64daf">drush_notify_send_text</a>($msg) {</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;  $override = <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;notify-cmd&#39;</span>, FALSE);</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;  <span class="keywordflow">if</span> (!empty($override)) {</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;    $cmd = $override;</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;  }</div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;    <span class="keywordflow">switch</span> (PHP_OS) {</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;      <span class="keywordflow">case</span> <span class="stringliteral">&#39;Darwin&#39;</span>:</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;        $cmd = <span class="stringliteral">&#39;terminal-notifier -message %s -title Drush&#39;</span>;</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;        $error_message = <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;terminal-notifier command failed. Please install it from https://github.com/alloy/terminal-notifier.&#39;</span>);</div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;        <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;      <span class="keywordflow">case</span> <span class="stringliteral">&#39;Linux&#39;</span>:</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;      <span class="keywordflow">default</span>:</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;        $icon = <a class="code" href="group__filesystemfunctions.html#ga4126321d45e8a9c454048869dd42a27c">drush_normalize_path</a>(DRUSH_BASE_PATH . <span class="stringliteral">&#39;/drush_logo-black.png&#39;</span>);</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;        $cmd = <span class="stringliteral">&quot;notify-send %s -i $icon&quot;</span>;</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;        $error_message = <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;notify-send command failed. Please install it as per http://coderstalk.blogspot.com/2010/02/how-to-install-notify-send-in-ubuntu.html.&#39;</span>);</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;        <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;    }</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;  }</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;  <span class="keywordflow">if</span> (!<a class="code" href="group__commandwrappers.html#gafd358ceac1286dbdd141ff2b8eb7d556">drush_shell_exec</a>($cmd, $msg)) {</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;    <span class="keywordflow">return</span> <a class="code" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4">drush_set_error</a>(<span class="stringliteral">&#39;NOTIFY_COMMAND_NOT_FOUND&#39;</span>, $error_message . <span class="charliteral">&#39; &#39;</span> . <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Or you may specify an alternate command to run by specifying --notify-cmd=&lt;my_command&gt;&#39;</span>));</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;  }</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;</div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;  <span class="keywordflow">return</span> TRUE;</div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;}</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment"> * Send an audio-based system notification.</span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment"> * This function is only automatically invoked with the additional use of the</span></div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment"> * --notify-audio flag or configuration state.</span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment"> * @param $msg</span></div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment"> *   Message for audio recital.</span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="comment"> * @return bool</span></div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"> *   TRUE on success, FALSE on failure</span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"><a class="code" href="notify_8drush_8inc.html#a1cf454258746f8e8a83c5fa9b9a91426">  167</a></span>&#160;<span class="keyword">function</span> <a class="code" href="notify_8drush_8inc.html#a1cf454258746f8e8a83c5fa9b9a91426">drush_notify_send_audio</a>($msg) {</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;  $override = <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;notify-cmd-audio&#39;</span>, FALSE);</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;  <span class="keywordflow">if</span> (!empty($override)) {</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;    $cmd = $override;</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;  }</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;    <span class="keywordflow">switch</span> (PHP_OS) {</div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;      <span class="keywordflow">case</span> <span class="stringliteral">&#39;Darwin&#39;</span>:</div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;        $cmd = <span class="stringliteral">&#39;say %s&#39;</span>;</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;        <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;      <span class="keywordflow">case</span> <span class="stringliteral">&#39;Linux&#39;</span>:</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;      <span class="keywordflow">default</span>:</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;        $cmd = <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;notify-cmd-audio&#39;</span>, <span class="stringliteral">&#39;spd-say&#39;</span>) . <span class="stringliteral">&#39; %s&#39;</span>;</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;    }</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;  }</div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;</div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;  <span class="keywordflow">if</span> (!<a class="code" href="group__commandwrappers.html#gafd358ceac1286dbdd141ff2b8eb7d556">drush_shell_exec</a>($cmd, $msg)) {</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;    <span class="keywordflow">return</span> <a class="code" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4">drush_set_error</a>(<span class="stringliteral">&#39;NOTIFY_COMMAND_NOT_FOUND&#39;</span>, <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;The third party notification utility failed.&#39;</span>));</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;  }</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;}</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment"> * Identify if the given Drush request should trigger a notification.</span></div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment"> * @param $command</span></div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment"> *   Name of the command.</span></div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment"> * @return</span></div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment"> *   Boolean</span></div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"><a class="code" href="notify_8drush_8inc.html#a164c0fa71b4c3c581b887c130da76f6b">  198</a></span>&#160;<span class="keyword">function</span> <a class="code" href="notify_8drush_8inc.html#a164c0fa71b4c3c581b887c130da76f6b">drush_notify_allowed</a>($command) {</div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;  $notify = <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(array(<span class="stringliteral">&#39;notify&#39;</span>, <span class="stringliteral">&#39;notify-audio&#39;</span>), FALSE);</div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;  $execution = time() - $_SERVER[<span class="stringliteral">&#39;REQUEST_TIME&#39;</span>];</div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;</div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;  <span class="keywordflow">return</span> ($notify === TRUE ||</div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;    (is_numeric($notify) &amp;&amp; $notify &gt; 0 &amp;&amp; $execution &gt; $notify));</div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;}</div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 8 2014 09:04:53 for Drush by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>