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

init.drush.inc
Go to the documentation of this file.
1 <?php
2 
3 /**
4  * @file
5  * Set up local Drush configuration.
6  */
7 
9 
10 /**
11  * Implementation of hook_drush_command().
12  *
13  * @return
14  * An associative array describing your command(s).
15  */
16 function init_drush_command() {
17  $items['core-init'] = array(
18  'description' => 'Enrich the bash startup file with completion and aliases. Copy .drushrc file to ~/.drush',
19  'aliases' => array('init'),
20  'bootstrap' => DRUSH_BOOTSTRAP_NONE,
21  'package' => 'core',
22  'global-options' => array('editor', 'bg'),
23  'options' => array(
24  'edit' => 'Open the new config file in an editor.',
25  'add-path' => "Always add Drush to the \$PATH in the user's .bashrc file, even if it is already in the \$PATH. Use --no-add-path to skip updating .bashrc with the Drush \$PATH. Default is to update .bashrc only if Drush is not already in the \$PATH.",
26  ),
27  'examples' => array(
28  'drush core-init --edit' => 'Enrich Bash and open drush config file in editor.',
29  'drush core-init --edit --bg' => 'Return to shell prompt as soon as the editor window opens.',
30  ),
31  );
32  return $items;
33 }
34 
35 /**
36  * Initialize local Drush configuration
37  */
39  $home = drush_server_home();
40  $drush_config_dir = $home . "/.drush";
41  $drush_config_file = $drush_config_dir . "/drushrc.php";
42  $drush_bashrc = $drush_config_dir . "/drush.bashrc";
43  $drush_prompt = $drush_config_dir . "/drush.prompt.sh";
44  $drush_complete = $drush_config_dir . "/drush.complete.sh";
45  $examples_dir = DRUSH_BASE_PATH . "/examples";
46  $example_configuration = $examples_dir . "/example.drushrc.php";
47  $example_bashrc = $examples_dir . "/example.bashrc";
48  $example_prompt = $examples_dir . "/example.prompt.sh";
49  $example_complete = DRUSH_BASE_PATH . "/drush.complete.sh";
50  $bashrc_additions = array();
51 
52  // If Drush is not in the $PATH, then figure out which
53  // path to add so that Drush can be found globally.
54  $add_path = drush_get_option('add-path', NULL);
55  if ((!drush_which("drush") || $add_path) && ($add_path !== FALSE)) {
56  $drush_path = drush_find_path_to_drush($home);
57  $drush_path = preg_replace("%^" . preg_quote($home) . "/%", '$HOME/', $drush_path);
58 
59  $bashrc_additions["%$drush_path%"] = "# Path to Drush, added by 'drush init'.\nexport PATH=\"\$PATH:$drush_path\"\n\n";
60  }
61 
62  // Create a ~/.drush directory if it does not yet exist
63  if (!is_dir($drush_config_dir)) {
64  drush_mkdir($drush_config_dir);
65  }
66 
67  // If there is no ~/.drush/drushrc.php, then copy the
68  // example Drush configuration file here
69  if (!is_file($drush_config_file)) {
70  copy($example_configuration, $drush_config_file);
71  drush_log(dt("Copied example Drush configuration file to !path", array('!path' => $drush_config_file)), LogLevel::OK);
72  }
73 
74  // If there is no ~/.drush/drush.bashrc file, then copy
75  // the example bashrc file there
76  if (!is_file($drush_bashrc)) {
77  copy($example_bashrc, $drush_bashrc);
78  $pattern = basename($drush_bashrc);
79  $bashrc_additions["%$pattern%"] = "# Include Drush bash customizations.\n". drush_bash_addition($drush_bashrc);
80  drush_log(dt("Copied example Drush bash configuration file to !path", array('!path' => $drush_bashrc)), LogLevel::OK);
81  }
82 
83  // If there is no ~/.drush/drush.complete.sh file, then copy it there
84  if (!is_file($drush_complete)) {
85  copy($example_complete, $drush_complete);
86  $pattern = basename($drush_complete);
87  $bashrc_additions["%$pattern%"] = "# Include Drush completion.\n". drush_bash_addition($drush_complete);
88  drush_log(dt("Copied Drush completion file to !path", array('!path' => $drush_complete)), LogLevel::OK);
89  }
90 
91  // If there is no ~/.drush/drush.prompt.sh file, then copy
92  // the example prompt.sh file here
93  if (!is_file($drush_prompt)) {
94  copy($example_prompt, $drush_prompt);
95  $pattern = basename($drush_prompt);
96  $bashrc_additions["%$pattern%"] = "# Include Drush prompt customizations.\n". drush_bash_addition($drush_prompt);
97  drush_log(dt("Copied example Drush prompt file to !path", array('!path' => $drush_prompt)), LogLevel::OK);
98  }
99 
100  // Decide whether we want to add our Bash commands to
101  // ~/.bashrc or ~/.bash_profile
102  $bashrc = drush_init_find_bashrc($home);
103 
104  // Modify the user's bashrc file, adding our customizations.
105  $bashrc_contents = "";
106  if (file_exists($bashrc)) {
107  $bashrc_contents = file_get_contents($bashrc);
108  }
109  $new_bashrc_contents = $bashrc_contents;
110  foreach ($bashrc_additions as $pattern => $addition) {
111  // Only put in the addition if the pattern does not already
112  // exist in the bashrc file.
113  if (!preg_match($pattern, $new_bashrc_contents)) {
114  $new_bashrc_contents = $new_bashrc_contents . $addition;
115  }
116  }
117  if ($new_bashrc_contents != $bashrc_contents) {
118  if (drush_confirm(dt(implode('', $bashrc_additions) . "Append the above code to !file?", array('!file' => $bashrc)))) {
119  file_put_contents($bashrc, "\n\n". $new_bashrc_contents);
120  drush_log(dt("Updated bash configuration file !path", array('!path' => $bashrc)), LogLevel::OK);
121  drush_log(dt("Start a new shell in order to experience the improvements (e.g. `bash`)."), LogLevel::OK);
122  if (drush_get_option('edit')) {
123  $exec = drush_get_editor();
124  drush_shell_exec_interactive($exec, $drush_config_file, $drush_config_file);
125  }
126  }
127  else {
128  return drush_user_abort();
129  }
130  }
131  else {
132  drush_log(dt('No code added to !path', array('!path' => $bashrc)), LogLevel::OK);
133  }
134 }
135 
136 /**
137  * Determine which .bashrc file is best to use on this platform.
138  */
139 function drush_init_find_bashrc($home) {
140  return $home . "/.bashrc";
141 }
142 
143 /**
144  * Determine where Drush is located, so that we can add
145  * that location to the $PATH
146  */
147 function drush_find_path_to_drush($home) {
148  // First test: is Drush inside a vendor directory?
149  // Does vendor/bin exist? If so, use that. We do
150  // not have a good way to locate the 'bin' directory
151  // if it has been relocated in the composer.json config
152  // section.
153  if ($vendor_pos = strpos(DRUSH_BASE_PATH, "/vendor/")) {
154  $vendor_dir = substr(DRUSH_BASE_PATH, 0, $vendor_pos + 7);
155  $vendor_bin = $vendor_dir . '/bin';
156  if (is_dir($vendor_bin)) {
157  return $vendor_bin;
158  }
159  }
160 
161  // Fallback is to use the directory that Drush is in.
162  return DRUSH_BASE_PATH;
163 }
164 
165 function drush_bash_addition($file) {
166  return <<<EOD
167 if [ -f "$file" ] ; then
168  source $file
169 fi
170 
171 
172 EOD;
173 }

File

doxygen/html/init_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/init.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">init.drush.inc</div>  </div>
</div><!--header-->
<div class="contents">
<a href="init_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"> *   Set up local Drush configuration.</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;</div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;use <a class="code" href="classDrush_1_1Log_1_1LogLevel.html">Drush\Log\LogLevel</a>;</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;<span class="comment">/**</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * Implementation of hook_drush_command().</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"> * @return</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *   An associative array describing your command(s).</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="code" href="init_8drush_8inc.html#a52408be0e02c1e6e752913a9eb04bdc6">   16</a></span>&#160;<span class="keyword">function</span> <a class="code" href="init_8drush_8inc.html#a52408be0e02c1e6e752913a9eb04bdc6">init_drush_command</a>() {</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;  $items[<span class="stringliteral">&#39;core-init&#39;</span>] = array(</div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;    <span class="stringliteral">&#39;description&#39;</span> =&gt; <span class="stringliteral">&#39;Enrich the bash startup file with completion and aliases. Copy .drushrc file to ~/.drush&#39;</span>,</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;    <span class="stringliteral">&#39;aliases&#39;</span> =&gt; array(<span class="stringliteral">&#39;init&#39;</span>),</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;    <span class="stringliteral">&#39;bootstrap&#39;</span> =&gt; DRUSH_BOOTSTRAP_NONE,</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;    <span class="stringliteral">&#39;package&#39;</span> =&gt; <span class="stringliteral">&#39;core&#39;</span>,</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    <span class="stringliteral">&#39;global-options&#39;</span> =&gt; array(<span class="stringliteral">&#39;editor&#39;</span>, <span class="stringliteral">&#39;bg&#39;</span>),</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    <span class="stringliteral">&#39;options&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;      <span class="stringliteral">&#39;edit&#39;</span> =&gt; <span class="stringliteral">&#39;Open the new config file in an editor.&#39;</span>,</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;      <span class="stringliteral">&#39;add-path&#39;</span> =&gt; <span class="stringliteral">&quot;Always add Drush to the \$PATH in the user&#39;s .bashrc file, even if it is already in the \$PATH. Use --no-add-path to skip updating .bashrc with the Drush \$PATH. Default is to update .bashrc only if Drush is not already in the \$PATH.&quot;</span>,</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;    <span class="stringliteral">&#39;examples&#39;</span> =&gt; array(</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;      <span class="stringliteral">&#39;drush core-init --edit&#39;</span> =&gt; <span class="stringliteral">&#39;Enrich Bash and open drush config file in editor.&#39;</span>,</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;      <span class="stringliteral">&#39;drush core-init --edit --bg&#39;</span> =&gt; <span class="stringliteral">&#39;Return to shell prompt as soon as the editor window opens.&#39;</span>,</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="keywordflow">return</span> $items;</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;}</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"></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">   36</span>&#160;<span class="comment"> * Initialize local Drush configuration</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="code" href="init_8drush_8inc.html#ab594d5d03b6d63ea88be1a5d289fa36e">   38</a></span>&#160;<span class="keyword">function</span> <a class="code" href="init_8drush_8inc.html#ab594d5d03b6d63ea88be1a5d289fa36e">drush_init_core_init</a>() {</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;  $home = <a class="code" href="includes_2environment_8inc.html#afae6d4a5a12623e5502ca262346c799b">drush_server_home</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;  $drush_config_dir = $home . <span class="stringliteral">&quot;/.drush&quot;</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;  $drush_config_file = $drush_config_dir . <span class="stringliteral">&quot;/drushrc.php&quot;</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;  $drush_bashrc = $drush_config_dir . <span class="stringliteral">&quot;/drush.bashrc&quot;</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;  $drush_prompt = $drush_config_dir . <span class="stringliteral">&quot;/drush.prompt.sh&quot;</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;  $drush_complete = $drush_config_dir . <span class="stringliteral">&quot;/drush.complete.sh&quot;</span>;</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  $examples_dir = DRUSH_BASE_PATH . <span class="stringliteral">&quot;/examples&quot;</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  $example_configuration = $examples_dir . <span class="stringliteral">&quot;/example.drushrc.php&quot;</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  $example_bashrc = $examples_dir . <span class="stringliteral">&quot;/example.bashrc&quot;</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  $example_prompt = $examples_dir . <span class="stringliteral">&quot;/example.prompt.sh&quot;</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  $example_complete = DRUSH_BASE_PATH . <span class="stringliteral">&quot;/drush.complete.sh&quot;</span>;</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  $bashrc_additions = array();</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;  <span class="comment">// If Drush is not in the $PATH, then figure out which</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;  <span class="comment">// path to add so that Drush can be found globally.</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;  $add_path = <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;add-path&#39;</span>, NULL);</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;  <span class="keywordflow">if</span> ((!<a class="code" href="group__commandwrappers.html#ga3baeb8291ac5fa5e67fd5cc1b1ee1f5e">drush_which</a>(<span class="stringliteral">&quot;drush&quot;</span>) || $add_path) &amp;&amp; ($add_path !== FALSE)) {</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    $drush_path = <a class="code" href="init_8drush_8inc.html#a857121a2991694158ab1728af9986567">drush_find_path_to_drush</a>($home);</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    $drush_path = preg_replace(<span class="stringliteral">&quot;%^&quot;</span> . preg_quote($home) . <span class="stringliteral">&quot;/%&quot;</span>, <span class="stringliteral">&#39;$HOME/&#39;</span>, $drush_path);</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    $bashrc_additions[<span class="stringliteral">&quot;%$drush_path%&quot;</span>] = <span class="stringliteral">&quot;# Path to Drush, added by &#39;drush init&#39;.\nexport PATH=\&quot;\$PATH:$drush_path\&quot;\n\n&quot;</span>;</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">// Create a ~/.drush directory if it does not yet exist</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;  <span class="keywordflow">if</span> (!is_dir($drush_config_dir)) {</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <a class="code" href="group__filesystemfunctions.html#ga6027285d97028ad3299d3aa262be8c2f">drush_mkdir</a>($drush_config_dir);</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;  }</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;  <span class="comment">// If there is no ~/.drush/drushrc.php, then copy the</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;  <span class="comment">// example Drush configuration file here</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  <span class="keywordflow">if</span> (!is_file($drush_config_file)) {</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    copy($example_configuration, $drush_config_file);</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <a class="code" href="group__logging.html#ga2a8afad8eafb1382e24a5601bc962e71">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;Copied example Drush configuration file to !path&quot;</span>, array(<span class="stringliteral">&#39;!path&#39;</span> =&gt; $drush_config_file)), LogLevel::OK);</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;  }</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;  <span class="comment">// If there is no ~/.drush/drush.bashrc file, then copy</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  <span class="comment">// the example bashrc file there</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  <span class="keywordflow">if</span> (!is_file($drush_bashrc)) {</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    copy($example_bashrc, $drush_bashrc);</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    $pattern = basename($drush_bashrc);</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    $bashrc_additions[<span class="stringliteral">&quot;%$pattern%&quot;</span>] = <span class="stringliteral">&quot;# Include Drush bash customizations.\n&quot;</span>. drush_bash_addition($drush_bashrc);</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <a class="code" href="group__logging.html#ga2a8afad8eafb1382e24a5601bc962e71">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;Copied example Drush bash configuration file to !path&quot;</span>, array(<span class="stringliteral">&#39;!path&#39;</span> =&gt; $drush_bashrc)), LogLevel::OK);</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;  }</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;  <span class="comment">// If there is no ~/.drush/drush.complete.sh file, then copy it there</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;  <span class="keywordflow">if</span> (!is_file($drush_complete)) {</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    copy($example_complete, $drush_complete);</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    $pattern = basename($drush_complete);</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    $bashrc_additions[<span class="stringliteral">&quot;%$pattern%&quot;</span>] = <span class="stringliteral">&quot;# Include Drush completion.\n&quot;</span>. drush_bash_addition($drush_complete);</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    <a class="code" href="group__logging.html#ga2a8afad8eafb1382e24a5601bc962e71">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;Copied Drush completion file to !path&quot;</span>, array(<span class="stringliteral">&#39;!path&#39;</span> =&gt; $drush_complete)), LogLevel::OK);</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;  }</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;  <span class="comment">// If there is no ~/.drush/drush.prompt.sh file, then copy</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;  <span class="comment">// the example prompt.sh file here</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;  <span class="keywordflow">if</span> (!is_file($drush_prompt)) {</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    copy($example_prompt, $drush_prompt);</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    $pattern = basename($drush_prompt);</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    $bashrc_additions[<span class="stringliteral">&quot;%$pattern%&quot;</span>] = <span class="stringliteral">&quot;# Include Drush prompt customizations.\n&quot;</span>. drush_bash_addition($drush_prompt);</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    <a class="code" href="group__logging.html#ga2a8afad8eafb1382e24a5601bc962e71">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;Copied example Drush prompt file to !path&quot;</span>, array(<span class="stringliteral">&#39;!path&#39;</span> =&gt; $drush_prompt)), LogLevel::OK);</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;</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;  <span class="comment">// Decide whether we want to add our Bash commands to</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;  <span class="comment">// ~/.bashrc or ~/.bash_profile</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;  $bashrc = <a class="code" href="init_8drush_8inc.html#aad5db6704f9426f0cb8fcc26cd455ddc">drush_init_find_bashrc</a>($home);</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;  <span class="comment">// Modify the user&#39;s bashrc file, adding our customizations.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;  $bashrc_contents = <span class="stringliteral">&quot;&quot;</span>;</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;  <span class="keywordflow">if</span> (file_exists($bashrc)) {</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    $bashrc_contents = file_get_contents($bashrc);</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;  $new_bashrc_contents = $bashrc_contents;</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;  <span class="keywordflow">foreach</span> ($bashrc_additions as $pattern =&gt; $addition) {</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    <span class="comment">// Only put in the addition if the pattern does not already</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;    <span class="comment">// exist in the bashrc file.</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;    <span class="keywordflow">if</span> (!preg_match($pattern, $new_bashrc_contents)) {</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;      $new_bashrc_contents = $new_bashrc_contents . $addition;</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;    }</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;  }</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;  <span class="keywordflow">if</span> ($new_bashrc_contents != $bashrc_contents) {</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;    <span class="keywordflow">if</span> (<a class="code" href="group__userinput.html#gaa4169b83ff9dc4222af95d376b21268b">drush_confirm</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(implode(<span class="stringliteral">&#39;&#39;</span>, $bashrc_additions) . <span class="stringliteral">&quot;Append the above code to !file?&quot;</span>, array(<span class="stringliteral">&#39;!file&#39;</span> =&gt; $bashrc)))) {</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;      file_put_contents($bashrc, <span class="stringliteral">&quot;\n\n&quot;</span>. $new_bashrc_contents);</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;      <a class="code" href="group__logging.html#ga2a8afad8eafb1382e24a5601bc962e71">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;Updated bash configuration file !path&quot;</span>, array(<span class="stringliteral">&#39;!path&#39;</span> =&gt; $bashrc)), LogLevel::OK);</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;      <a class="code" href="group__logging.html#ga2a8afad8eafb1382e24a5601bc962e71">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;Start a new shell in order to experience the improvements (e.g. `bash`).&quot;</span>), LogLevel::OK);</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;      <span class="keywordflow">if</span> (<a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(<span class="stringliteral">&#39;edit&#39;</span>)) {</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;        $exec = <a class="code" href="group__commandwrappers.html#ga516aab026be224e57d9fc0fe9c3de79f">drush_get_editor</a>();</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;        <a class="code" href="group__commandwrappers.html#gad0b72e62d81d339d68dc2d3d36db75d6">drush_shell_exec_interactive</a>($exec, $drush_config_file, $drush_config_file);</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;    }</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;    <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;      <span class="keywordflow">return</span> <a class="code" href="group__errorhandling.html#ga366aaafdf8c774a58653c64a65b6d91c">drush_user_abort</a>();</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;  }</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;    <a class="code" href="group__logging.html#ga2a8afad8eafb1382e24a5601bc962e71">drush_log</a>(<a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;No code added to !path&#39;</span>, array(<span class="stringliteral">&#39;!path&#39;</span> =&gt; $bashrc)), LogLevel::OK);</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"></span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment"> * Determine which .bashrc file is best to use on this platform.</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"><a class="code" href="init_8drush_8inc.html#aad5db6704f9426f0cb8fcc26cd455ddc">  139</a></span>&#160;<span class="keyword">function</span> <a class="code" href="init_8drush_8inc.html#aad5db6704f9426f0cb8fcc26cd455ddc">drush_init_find_bashrc</a>($home) {</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;  <span class="keywordflow">return</span> $home . <span class="stringliteral">&quot;/.bashrc&quot;</span>;</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;}</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"> * Determine where Drush is located, so that we can add</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment"> * that location to the $PATH</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"><a class="code" href="init_8drush_8inc.html#a857121a2991694158ab1728af9986567">  147</a></span>&#160;<span class="keyword">function</span> <a class="code" href="init_8drush_8inc.html#a857121a2991694158ab1728af9986567">drush_find_path_to_drush</a>($home) {</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;  <span class="comment">// First test: is Drush inside a vendor directory?</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;  <span class="comment">// Does vendor/bin exist?  If so, use that.  We do</span></div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;  <span class="comment">// not have a good way to locate the &#39;bin&#39; directory</span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;  <span class="comment">// if it has been relocated in the composer.json config</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;  <span class="comment">// section.</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;  <span class="keywordflow">if</span> ($vendor_pos = strpos(DRUSH_BASE_PATH, <span class="stringliteral">&quot;/vendor/&quot;</span>)) {</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;    $vendor_dir = substr(DRUSH_BASE_PATH, 0, $vendor_pos + 7);</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;    $vendor_bin = $vendor_dir . <span class="stringliteral">&#39;/bin&#39;</span>;</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;    <span class="keywordflow">if</span> (is_dir($vendor_bin)) {</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;      <span class="keywordflow">return</span> $vendor_bin;</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;    }</div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;  }</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;  <span class="comment">// Fallback is to use the directory that Drush is in.</span></div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;  <span class="keywordflow">return</span> DRUSH_BASE_PATH;</div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;}</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="keyword">function</span> drush_bash_addition($file) {</div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;  <span class="keywordflow">return</span> &lt;&lt;&lt;EOD</div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="keywordflow">if</span> [ -f <span class="stringliteral">&quot;$file&quot;</span> ] ; then</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;  source $file</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;fi</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;EOD;</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat May 7 2016 07:27:27 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>