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

  1. 7.x doxygen/html/usage_8drush_8inc_source.html
  2. master doxygen/html/usage_8drush_8inc_source.html
usage.drush.inc
Go to the documentation of this file.
1 <?php
2 
3 /**
4  * @file
5  * Send scrubbed usage data to drush. Omits arguments and option values in order
6  * to assure that no sensitive data is shared. See http://drupal.org/node/1246738.
7  */
8 
10 
11 /**
12  * To send usage data, add the following to a .drushrc.php file:
13  * $options['drush_usage_log'] = TRUE;
14  * $options['drush_usage_send'] = TRUE;
15  * $options['drush_usage_size'] = 51200;
16 */
17 
18 function usage_drush_command() {
19  $disclaimer = 'Usage statistics contain the Drush command name and the Drush option names, but no arguments or option values.';
20  $items['usage-show'] = array(
21  'bootstrap' => DRUSH_BOOTSTRAP_NONE,
22  'description' => 'Show Drush usage information that has been logged but not sent. ' . $disclaimer,
23  'hidden' => TRUE,
24  'examples' => array(
25  'drush usage-show' => 'Show cached usage statistics.',
26  '$options[\'drush_usage_log\'] = TRUE;' => 'Specify in a .drushrc.php file that usage information should be logged locally in a usage statistics file.',
27  ),
28  'aliases' => array('ushow'),
29  );
30  $items['usage-send'] = array(
31  'bootstrap' => DRUSH_BOOTSTRAP_NONE,
32  'hidden' => TRUE,
33  'description' => 'Send anonymous Drush usage information to statistics logging site. ' . $disclaimer,
34  'examples' => array(
35  'drush usage-send' => 'Immediately send cached usage statistics.',
36  '$options[\'drush_usage_send\'] = TRUE;' => 'Specify in a .drushrc.php file that usage information should be sent.',
37  '$options[\'drush_usage_size\'] = 10240;' => 'Specify the frequency (file size) that usage information should be sent.',
38  ),
39  'aliases' => array('usend'),
40  );
41  return $items;
42 }
43 
44 /**
45  * Log and/or send usage data to Mongolab.
46  *
47  * An organization can implement own hook_drush_exit() to send data to a
48  * different endpoint.
49  */
50 function usage_drush_exit() {
51  // Ignore statistics for simulated commands. (n.b. in simulated mode, _drush_usage_mongolab will print rather than send statistics)
52  if (!drush_get_context('DRUSH_SIMULATE')) {
53  $file = _drush_usage_get_file();
54  if (drush_get_option('drush_usage_log', FALSE)) {
55  _drush_usage_log(drush_get_command(), $file);
56  }
57  if (drush_get_option('drush_usage_send', FALSE)) {
58  _drush_usage_mongolab($file, drush_get_option('drush_usage_size', 51200));
59  }
60  }
61 }
62 
63 /**
64  * Set option to send usage to Mongolab.
65  *
66  * See usage_drush_exit() for more information.
67  */
68 function drush_usage_send() {
69  $file = _drush_usage_get_file(TRUE);
70  if ($file) {
71  drush_set_option('drush_usage_send', TRUE);
72  drush_set_option('drush_usage_size', 0);
73  drush_print(dt('To automatically send anonymous usage data, add the following to a .drushrc.php file: $options[\'drush_usage_send\'] = TRUE;'));
74  }
75  else {
76  return drush_set_error('DRUSH_NO_USAGE_FILE', dt('No usage file; set $options[\'drush_usage_log\'] = TRUE; in a .drushrc.php file to enable.'));
77  }
78 }
79 
80 /**
81  * Displays usage file.
82  */
83 function drush_usage_show() {
84  $file = _drush_usage_get_file(TRUE);
85  if ($file) {
86  $json = '[' . file_get_contents($file) . ']';
87  $usage_data = json_decode($json);
88  foreach ($usage_data as $item) {
89  $cmd = $item->cmd;
90  $options = (array) $item->opt;
91  array_unshift($options, '');
92  drush_print($cmd . implode(' --', $options));
93  }
94  }
95  else {
96  return drush_set_error('DRUSH_NO_USAGE_FILE', dt('No usage file; set $options[\'drush_usage_log\'] = TRUE; in a .drushrc.php file to enable.'));
97  }
98 }
99 
100 /**
101  * Returns path to usage file.
102  */
103 function _drush_usage_get_file($required = FALSE) {
104  $file = drush_directory_cache('usage') . '/usage.txt';
105  if (!file_exists($file) && $required) {
106  return FALSE;
107 
108  }
109  return $file;
110 }
111 
112 function _drush_usage_log($command, $file) {
113  $options = drush_get_command_options_extended($command);
114 
115  $used = drush_get_merged_options();
116  $command_specific = array_intersect(array_keys($used), array_keys($options));
117  $record = array(
118  'date' => $_SERVER['REQUEST_TIME'],
119  'cmd' => $command['command'],
120  'opt' => $command_specific,
121  'major' => DRUSH_MAJOR_VERSION,
122  'minor' => DRUSH_MINOR_VERSION,
123  'os' => php_uname('s'),
124  'host' => md5(php_uname('n') . get_current_user()),
125  );
126  $prequel = (file_exists($file)) ? ",\n" : "";
127  if (file_put_contents($file, $prequel . json_encode($record), FILE_APPEND)) {
128  drush_log(dt('Logged command and option names to local cache.'), LogLevel::DEBUG);
129  }
130  else {
131  drush_log(dt('Failed to log command and option names to local cache.'), LogLevel::DEBUG);
132  }
133 }
134 
135 // We only send data periodically to save network traffic and delay. Files
136 // are sent once they grow over 50KB (configurable).
137 function _drush_usage_mongolab($file, $min_size_to_send) {
138  $json = '[' . file_get_contents($file) . ']';
139  if (filesize($file) > $min_size_to_send) {
141  $apikey = '4eb95456e4b0bcd285d8135d'; // submitter account.
142  $database = 'usage';
143  $collection = 'usage';
144  $action = "/databases/$database/collections/$collection";
145  $url = $base . $action . "?apiKey=$apikey";
146  $header = 'Content-Type: application/json';
147  if (!drush_shell_exec("wget -q -O - --no-check-certificate --timeout=20 --header=\"$header\" --post-data %s %s", $json, $url)) {
148  if (!drush_shell_exec("curl -s --connect-timeout 20 --header \"$header\" --data %s %s", $json, $url)) {
149  drush_log(dt('Drush usage statistics failed to post.'), LogLevel::DEBUG);
150  return FALSE;
151  }
152  }
153  drush_log(dt('Drush usage statistics successfully posted.'), LogLevel::DEBUG);
154  // Empty the usage.txt file.
155  unlink($file);
156  return TRUE;
157  }
158 }

File

doxygen/html/usage_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/usage.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="namespaces.html"><span>Namespaces</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><a href="examples.html"><span>Examples</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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><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">usage.drush.inc</div>  </div>
</div><!--header-->
<div class="contents">
<a href="usage_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</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">/**</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * @file</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *   Send scrubbed usage data to drush. Omits arguments and option values in order</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *   to assure that no sensitive data is shared. See http://drupal.org/node/1246738.</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;</div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;use <a class="code" href="classDrush_1_1Log_1_1LogLevel.html">Drush\Log\LogLevel</a>;</div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"></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"> * To send usage data, add the following to a .drushrc.php file:</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * $options[&#39;drush_usage_log&#39;] = TRUE;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * $options[&#39;drush_usage_send&#39;] = TRUE;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * $options[&#39;drush_usage_size&#39;] = 51200;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="code" href="usage_8drush_8inc.html#aa3c21e2eb03c01ddabd57ecbe5a55317">   18</a></span>&#160;<span class="keyword">function</span> <a class="code" href="usage_8drush_8inc.html#aa3c21e2eb03c01ddabd57ecbe5a55317">usage_drush_command</a>() {</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;  $disclaimer = <span class="stringliteral">&#39;Usage statistics contain the Drush command name and the Drush option names, but no arguments or option values.&#39;</span>;</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;  $items[<span class="stringliteral">&#39;usage-show&#39;</span>] = array(</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;    <span class="stringliteral">&#39;bootstrap&#39;</span> =&gt; DRUSH_BOOTSTRAP_NONE,</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Show Drush usage information that has been logged but not sent.  &#39;</span> . $disclaimer,</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    <span class="stringliteral">&#39;hidden&#39;</span> =&gt; TRUE,</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    <span class="stringliteral">&#39;examples&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;      <span class="stringliteral">&#39;drush usage-show&#39;</span> =&gt; <span class="stringliteral">&#39;Show cached usage statistics.&#39;</span>,</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;      <span class="stringliteral">&#39;$options[\&#39;drush_usage_log\&#39;]  = TRUE;&#39;</span> =&gt; <span class="stringliteral">&#39;Specify in a .drushrc.php file that usage information should be logged locally in a usage statistics file.&#39;</span>,</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    ),</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <span class="stringliteral">&#39;aliases&#39;</span> =&gt; array(<span class="stringliteral">&#39;ushow&#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;  $items[<span class="stringliteral">&#39;usage-send&#39;</span>] = array(</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <span class="stringliteral">&#39;bootstrap&#39;</span> =&gt; DRUSH_BOOTSTRAP_NONE,</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="stringliteral">&#39;hidden&#39;</span> =&gt; TRUE,</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Send anonymous Drush usage information to statistics logging site.  &#39;</span> . $disclaimer,</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    <span class="stringliteral">&#39;examples&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;      <span class="stringliteral">&#39;drush usage-send&#39;</span> =&gt; <span class="stringliteral">&#39;Immediately send cached usage statistics.&#39;</span>,</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;      <span class="stringliteral">&#39;$options[\&#39;drush_usage_send\&#39;]  = TRUE;&#39;</span> =&gt; <span class="stringliteral">&#39;Specify in a .drushrc.php file that usage information should be sent.&#39;</span>,</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;      <span class="stringliteral">&#39;$options[\&#39;drush_usage_size\&#39;]  = 10240;&#39;</span> =&gt; <span class="stringliteral">&#39;Specify the frequency (file size) that usage information should be sent.&#39;</span>,</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    ),</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="stringliteral">&#39;aliases&#39;</span> =&gt; array(<span class="stringliteral">&#39;usend&#39;</span>),</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;  );</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;  <span class="keywordflow">return</span> $items;</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;<span class="comment"></span></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"> * Log and/or send usage data to Mongolab.</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"> * An organization can implement own hook_drush_exit() to send data to a</span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"> * different endpoint.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="usage_8drush_8inc.html#a0a90320da8f9df59381caaf3338d60cf">   50</a></span>&#160;<span class="keyword">function</span> <a class="code" href="usage_8drush_8inc.html#a0a90320da8f9df59381caaf3338d60cf">usage_drush_exit</a>() {</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  <span class="comment">// Ignore statistics for simulated commands. (n.b. in simulated mode, _drush_usage_mongolab will print rather than send statistics)</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;  <span class="keywordflow">if</span> (!<a class="code" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5">drush_get_context</a>(<span class="stringliteral">&#39;DRUSH_SIMULATE&#39;</span>)) {</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    $file = <a class="code" href="usage_8drush_8inc.html#ad52add4a2eb3f87d4d284409b2003039">_drush_usage_get_file</a>();</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="keywordflow">if</span> (<a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;drush_usage_log&#39;</span>, FALSE)) {</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;      _drush_usage_log(<a class="code" href="context_8inc.html#a8fc57227375a540fea5314b154576354">drush_get_command</a>(), $file);</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    }</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <span class="keywordflow">if</span> (<a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;drush_usage_send&#39;</span>, FALSE)) {</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;      _drush_usage_mongolab($file, <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;drush_usage_size&#39;</span>, 51200));</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    }</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  }</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;}</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment"> * Set option to send usage to Mongolab.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"> * See usage_drush_exit() for more information.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="usage_8drush_8inc.html#a315af941461f0a0d3b4ec1c5063d94ac">   68</a></span>&#160;<span class="keyword">function</span> <a class="code" href="usage_8drush_8inc.html#a315af941461f0a0d3b4ec1c5063d94ac">drush_usage_send</a>() {</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  $file = <a class="code" href="usage_8drush_8inc.html#ad52add4a2eb3f87d4d284409b2003039">_drush_usage_get_file</a>(TRUE);</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;  <span class="keywordflow">if</span> ($file) {</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <a class="code" href="context_8inc.html#aa4b55e2f6174c8b6efaa8f23a0f9e0af">drush_set_option</a>(<span class="stringliteral">&#39;drush_usage_send&#39;</span>, TRUE);</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <a class="code" href="context_8inc.html#aa4b55e2f6174c8b6efaa8f23a0f9e0af">drush_set_option</a>(<span class="stringliteral">&#39;drush_usage_size&#39;</span>, 0);</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <a class="code" href="group__outputfunctions.html#ga63acbb94925d6d2693e235e966bba740">drush_print</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;To automatically send anonymous usage data, add the following to a .drushrc.php file: $options[\&#39;drush_usage_send\&#39;] = TRUE;&#39;</span>));</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;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keywordflow">return</span> <a class="code" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4">drush_set_error</a>(<span class="stringliteral">&#39;DRUSH_NO_USAGE_FILE&#39;</span>, <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;No usage file; set $options[\&#39;drush_usage_log\&#39;] = TRUE; in a .drushrc.php file to enable.&#39;</span>));</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;  }</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;}</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">/**</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"> * Displays usage file.</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="code" href="usage_8drush_8inc.html#ab9ed81c63a7f92ea9336314205780bd0">   83</a></span>&#160;<span class="keyword">function</span> <a class="code" href="usage_8drush_8inc.html#ab9ed81c63a7f92ea9336314205780bd0">drush_usage_show</a>() {</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;  $file = <a class="code" href="usage_8drush_8inc.html#ad52add4a2eb3f87d4d284409b2003039">_drush_usage_get_file</a>(TRUE);</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;  <span class="keywordflow">if</span> ($file) {</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    $json = <span class="charliteral">&#39;[&#39;</span> . file_get_contents($file) . <span class="charliteral">&#39;]&#39;</span>;</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    $usage_data = json_decode($json);</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    <span class="keywordflow">foreach</span> ($usage_data as $item) {</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;      $cmd = $item-&gt;cmd;</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;      $options = (array) $item-&gt;opt;</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;      array_unshift($options, <span class="stringliteral">&#39;&#39;</span>);</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;      <a class="code" href="group__outputfunctions.html#ga63acbb94925d6d2693e235e966bba740">drush_print</a>($cmd . implode(<span class="stringliteral">&#39; --&#39;</span>, $options));</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    }</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;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    <span class="keywordflow">return</span> <a class="code" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4">drush_set_error</a>(<span class="stringliteral">&#39;DRUSH_NO_USAGE_FILE&#39;</span>, <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;No usage file; set $options[\&#39;drush_usage_log\&#39;] = TRUE; in a .drushrc.php file to enable.&#39;</span>));</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;}</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">/**</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment"> * Returns path to usage file.</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="code" href="usage_8drush_8inc.html#ad52add4a2eb3f87d4d284409b2003039">  103</a></span>&#160;<span class="keyword">function</span> <a class="code" href="usage_8drush_8inc.html#ad52add4a2eb3f87d4d284409b2003039">_drush_usage_get_file</a>($required = FALSE) {</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;  $file = <a class="code" href="includes_2environment_8inc.html#a92afdf9afda25ac6d226ba45f6f1fbe0">drush_directory_cache</a>(<span class="stringliteral">&#39;usage&#39;</span>) . <span class="stringliteral">&#39;/usage.txt&#39;</span>;</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;  <span class="keywordflow">if</span> (!file_exists($file) &amp;&amp; $required) {</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;    <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;  }</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;  <span class="keywordflow">return</span> $file;</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;}</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="keyword">function</span> _drush_usage_log($command, $file) {</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;  $options = <a class="code" href="group__dispatching.html#ga03019e7753cdfd13f17e7d05e6453486">drush_get_command_options_extended</a>($command);</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;  $used = <a class="code" href="context_8inc.html#a72dfb89d6a4ba0bb143e3256f997d2b8">drush_get_merged_options</a>();</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;  $command_specific = array_intersect(array_keys($used), array_keys($options));</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;  $record = array(</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;    <span class="stringliteral">&#39;date&#39;</span> =&gt; $_SERVER[<span class="stringliteral">&#39;REQUEST_TIME&#39;</span>],</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;    <span class="stringliteral">&#39;cmd&#39;</span> =&gt; $command[<span class="stringliteral">&#39;command&#39;</span>],</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;    <span class="stringliteral">&#39;opt&#39;</span> =&gt; $command_specific,</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    <span class="stringliteral">&#39;major&#39;</span> =&gt; DRUSH_MAJOR_VERSION,</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    <span class="stringliteral">&#39;minor&#39;</span> =&gt; DRUSH_MINOR_VERSION,</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    <span class="stringliteral">&#39;os&#39;</span> =&gt; php_uname(<span class="charliteral">&#39;s&#39;</span>),</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    <span class="stringliteral">&#39;host&#39;</span> =&gt; md5(php_uname(<span class="charliteral">&#39;n&#39;</span>) . get_current_user()),</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;  );</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;  $prequel = (file_exists($file)) ? <span class="stringliteral">&quot;,\n&quot;</span> : <span class="stringliteral">&quot;&quot;</span>;</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;  <span class="keywordflow">if</span> (file_put_contents($file, $prequel . json_encode($record), FILE_APPEND)) {</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    <a class="code" href="group__logging.html#ga47324b65808524558a488916b150dd51">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Logged command and option names to local cache.&#39;</span>), LogLevel::DEBUG);</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">else</span> {</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;    <a class="code" href="group__logging.html#ga47324b65808524558a488916b150dd51">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Failed to log command and option names to local cache.&#39;</span>), LogLevel::DEBUG);</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;}</div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment">// We only send data periodically to save network traffic and delay. Files</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">// are sent once they grow over 50KB (configurable).</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="keyword">function</span> _drush_usage_mongolab($file, $min_size_to_send) {</div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;  $json = <span class="charliteral">&#39;[&#39;</span> . file_get_contents($file) . <span class="charliteral">&#39;]&#39;</span>;</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;  <span class="keywordflow">if</span> (filesize($file) &gt; $min_size_to_send) {</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;    $base = <span class="stringliteral">&#39;https://api.mongolab.com/api/1&#39;</span>;</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    $apikey = <span class="stringliteral">&#39;4eb95456e4b0bcd285d8135d&#39;</span>; <span class="comment">// submitter account.</span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;    $database = <span class="stringliteral">&#39;usage&#39;</span>;</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;    $collection = <span class="stringliteral">&#39;usage&#39;</span>;</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;    $action = <span class="stringliteral">&quot;/databases/$database/collections/$collection&quot;</span>;</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;    $url = $base . $action . <span class="stringliteral">&quot;?apiKey=$apikey&quot;</span>;</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;    $header = <span class="stringliteral">&#39;Content-Type: application/json&#39;</span>;</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;    <span class="keywordflow">if</span> (!<a class="code" href="group__commandwrappers.html#gafd358ceac1286dbdd141ff2b8eb7d556">drush_shell_exec</a>(<span class="stringliteral">&quot;wget -q -O - --no-check-certificate --timeout=20 --header=\&quot;$header\&quot; --post-data %s %s&quot;</span>, $json, $url)) {</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>(<span class="stringliteral">&quot;curl -s --connect-timeout 20 --header \&quot;$header\&quot; --data %s %s&quot;</span>, $json, $url)) {</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;        <a class="code" href="group__logging.html#ga47324b65808524558a488916b150dd51">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Drush usage statistics failed to post.&#39;</span>), LogLevel::DEBUG);</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;        <span class="keywordflow">return</span> FALSE;</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;    }</div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;    <a class="code" href="group__logging.html#ga47324b65808524558a488916b150dd51">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Drush usage statistics successfully posted.&#39;</span>), LogLevel::DEBUG);</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;    <span class="comment">// Empty the usage.txt file.</span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;    unlink($file);</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;    <span class="keywordflow">return</span> TRUE;</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;  }</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 17 2016 07:27:20 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>