Drush: commands/core/rsync.core.inc Source File

  1. 7.x doxygen/html/rsync_8core_8inc_source.html
  2. master doxygen/html/rsync_8core_8inc_source.html
1 <?php
2 
4 
5 /*
6  * Implements COMMAND hook init.
7  */
8 function drush_core_rsync_init() {
9  // Try to get @self defined when --uri was not provided.
11 }
12 
13 /**
14  * A command callback.
15  *
16  * @param source
17  * A site alias ("@dev") or site specification ("/path/to/drupal#mysite.com")
18  * followed by an optional path (":path/to/sync"), or any path
19  * that could be passed to rsync ("user@server.com:/path/to/dir/").
20  * @param destination
21  * Same format as source.
22  * @param additional_options
23  * An array of options that overrides whatever was passed in on
24  * the command line (like the 'process' context, but only for
25  * the scope of this one call).
26  */
27 function drush_core_rsync($source, $destination, $additional_options = array()) {
28  // Preflight source in case it defines aliases used by the destination
30  // After preflight, evaluate file paths. We evaluate destination paths first, because
31  // there is a first-one-wins policy with --exclude-paths, and we want --target-command-specific
32  // to take precedence over --source-command-specific.
33  $destination_settings = drush_sitealias_evaluate_path($destination, $additional_options, FALSE, "rsync", 'target-');
34  $source_settings = drush_sitealias_evaluate_path($source, $additional_options, FALSE, "rsync", 'source-');
35  $source_path = $source_settings['evaluated-path'];
36  $destination_path = $destination_settings['evaluated-path'];
37 
38  if (!isset($source_settings)) {
39  return drush_set_error('DRUSH_BAD_PATH', dt('Could not evaluate source path !path.', array('!path' => $source)));
40  }
41  if (!isset($destination_settings)) {
42  return drush_set_error('DRUSH_BAD_PATH', dt('Could not evaluate destination path !path.', array('!path' => $destination)));
43  }
44 
45  // If the user path is the same for the source and the destination, then
46  // always add a slash to the end of the source. If the user path is not
47  // the same in the source and the destination, then you need to know how
48  // rsync paths work, and put on the trailing '/' if you want it.
49  if ($source_settings['user-path'] == $destination_settings['user-path']) {
50  $source_path .= '/';
51  }
52  // Prompt for confirmation. This is destructive.
53  if (!drush_get_context('DRUSH_SIMULATE')) {
54  drush_print(dt("You will delete files in !target and replace with data from !source", array('!source' => $source_path, '!target' => $destination_path)));
55  if (!drush_confirm(dt('Do you really want to continue?'))) {
56  return drush_user_abort();
57  }
58  }
59 
60  // Next, check to see if both the source and the destination are remote.
61  // If so, then we'll process this as an rsync from source to local,
62  // followed by an rsync from local to the destination.
63  if (drush_sitealias_is_remote_site($source_settings) && drush_sitealias_is_remote_site($destination_settings)) {
64  return _drush_core_rsync_both_remote($source, $destination, $additional_options, $source_path);
65  }
66 
67  // Exclude settings is the default only when both the source and
68  // the destination are aliases or site names. Therefore, include
69  // settings will be the default whenever either the source or the
70  // destination contains a : or a /.
71  $include_settings_is_default = (strpos($source . $destination, ':') !== FALSE) || (strpos($source . $destination, '/') !== FALSE);
72 
73  $options = _drush_build_rsync_options($additional_options, $include_settings_is_default);
74 
75  // Get all of the args and options that appear after the command name.
76  $original_args = drush_get_original_cli_args_and_options();
77  foreach ($original_args as $original_option) {
78  if ($original_option{0} == '-') {
79  $options .= ' ' . $original_option;
80  }
81  }
82 
83  drush_backend_set_result($destination_path);
84  // Go ahead and call rsync with the paths we determined
85  return drush_core_exec_rsync($source_path, $destination_path, $options);
86 }
87 
88 /**
89  * Make a direct call to rsync after the source and destination paths
90  * have been evaluated.
91  *
92  * @param $source
93  * Any path that can be passed to rsync.
94  * @param $destination
95  * Any path that can be passed to rsync.
96  * @param $additional_options
97  * An array of options that overrides whatever was passed in on the command
98  * line (like the 'process' context, but only for the scope of this one
99  * call).
100  * @param $include_settings_is_default
101  * If TRUE, then settings.php will be transferred as part of the rsync unless
102  * --exclude-conf is specified. If FALSE, then settings.php will be excluded
103  * from the transfer unless --include-conf is specified.
104  * @param $live_output
105  * If TRUE, output goes directly to the terminal using system(). If FALSE,
106  * rsync is executed with drush_shell_exec() with output in
108  *
109  * @return
110  * TRUE on success, FALSE on failure.
111  */
112 function drush_core_call_rsync($source, $destination, $additional_options = array(), $include_settings_is_default = TRUE, $live_output = TRUE) {
113  $options = _drush_build_rsync_options($additional_options, $include_settings_is_default);
114  return drush_core_exec_rsync($source, $destination, $options, $additional_options, $live_output);
115 }
116 
117 function drush_core_exec_rsync($source, $destination, $options, $additional_options = array(), $live_output = TRUE) {
118  $ssh_options = drush_get_option_override($additional_options, 'ssh-options', '');
119  $exec = "rsync -e 'ssh $ssh_options' $options $source $destination";
120 
121  if ($live_output) {
122  $exec_result = drush_op_system($exec);
123  $result = ($exec_result == 0);
124  }
125  else {
126  $result = drush_shell_exec($exec);
127  }
128 
129  if (!$result) {
130  drush_set_error('DRUSH_RSYNC_FAILED', dt("Could not rsync from !source to !dest", array('!source' => $source, '!dest' => $destination)));
131  }
132 
133  return $result;
134 }
135 
136 function _drush_build_rsync_options($additional_options, $include_settings_is_default = TRUE) {
137  $options = '';
138  // Exclude vcs reserved files.
139  if (!_drush_rsync_option_exists('include-vcs', $additional_options)) {
141  foreach ($vcs_files as $file) {
142  $options .= ' --exclude="'.$file.'"';
143  }
144  }
145  else {
146  unset($additional_options['include-vcs']);
147  }
148 
149  $mode = '-akz';
150  // Process --include-paths and --exclude-paths options the same way
151  foreach (array('include', 'exclude') as $include_exclude) {
152  // Get the option --include-paths or --exclude-paths and explode to an array of paths
153  // that we will translate into an --include or --exclude option to pass to rsync
154  $inc_ex_path = explode(PATH_SEPARATOR, drush_get_option($include_exclude . '-paths', ''));
155  foreach ($inc_ex_path as $one_path_to_inc_ex) {
156  if (!empty($one_path_to_inc_ex)) {
157  $options .= ' --' . $include_exclude . '="' . $one_path_to_inc_ex . '"';
158  }
159  }
160  // Remove stuff inserted by evaluate path
161  unset($additional_options[$include_exclude . '-paths']);
162  unset($additional_options[$include_exclude . '-files-processed']);
163  }
164  // drush_core_rsync passes in $include_settings_is_default such that
165  // 'exclude-conf' is the default when syncing from one alias to
166  // another, and 'include-conf' is the default when a path component
167  // is included.
168  if ($include_settings_is_default ? _drush_rsync_option_exists('exclude-conf', $additional_options) : !_drush_rsync_option_exists('include-conf', $additional_options)) {
169  $options .= ' --exclude="settings.php"';
170  unset($additional_options['exclude-conf']);
171  }
172  if (_drush_rsync_option_exists('exclude-sites', $additional_options)) {
173  $options .= ' --include="sites/all" --exclude="sites/*"';
174  unset($additional_options['exclude-sites']);
175  }
176  if (_drush_rsync_option_exists('mode', $additional_options)) {
177  $mode = "-" . drush_get_option_override($additional_options, 'mode');
178  unset($additional_options['mode']);
179  }
180  if (drush_get_context('DRUSH_VERBOSE')) {
181  // the drush_op() will be verbose about the command that gets executed.
182  $mode .= 'v';
183  $options .= ' --stats --progress';
184  }
185 
186  // Check if the user has set $options['rsync-version'] to enable rsync legacy version support.
187  // Drush was written for rsync 2.6.9 or later, so assume that version if nothing was explicitly set.
188  $rsync_version = drush_get_option(array('rsync-version','source-rsync-version','target-rsync-version'), '2.6.9');
189  $options_to_exclude = array('ssh-options');
190  foreach ($additional_options as $test_option => $value) {
191  // Downgrade some options for older versions of rsync
192  if ($test_option == 'remove-source-files') {
193  if (version_compare($rsync_version, '2.6.4', '<')) {
194  $test_option = NULL;
195  drush_log('Rsync does not support --remove-sent-files prior to version 2.6.4; some temporary files may remain undeleted.', LogLevel::WARNING);
196  }
197  elseif (version_compare($rsync_version, '2.6.9', '<')) {
198  $test_option = 'remove-sent-files';
199  }
200  }
201  if ((isset($test_option)) && !in_array($test_option, $options_to_exclude) && (isset($value) && !is_array($value))) {
202  if (($value === TRUE) || (!isset($value))) {
203  $options .= " --$test_option";
204  }
205  else {
206  $options .= " --$test_option=" . escapeshellarg($value);
207  }
208  }
209  }
210 
211  return $mode . $options;
212 }
213 
214 function _drush_rsync_option_exists($option, $additional_options) {
215  if (array_key_exists($option, $additional_options)) {
216  return TRUE;
217  }
218  else {
219  return drush_get_option($option, FALSE);
220  }
221 }
222 
223 /**
224  * Handle an rsync operation from a remote site to a remote
225  * site by first rsync'ing to a local location, and then
226  * copying that location to its final destination.
227  */
228 function _drush_core_rsync_both_remote($source, $destination, $additional_options, $source_path) {
229  $options = $additional_options + drush_redispatch_get_options();
230 
231  // Make a temporary directory to copy to. There are three
232  // cases to consider:
233  //
234  // 1. rsync @src:file.txt @dest:location
235  // 2. rsync @src:dir @dest:location
236  // 3. rsync @src:dir/ @dest:location
237  //
238  // We will explain each of these in turn.
239  //
240  // 1. Copy a single file. We'll split this up like so:
241  //
242  // rsync @src:file.txt /tmp/tmpdir
243  // rsync /tmp/tmpdir/file.txt @dest:location
244  //
245  // Since /tmp/tmpdir is empty, we could also rsync from
246  // '/tmp/tmpdir/' if we wished.
247  //
248  // 2. Copy a directory. A directory with the same name
249  // is copied to the destination. We'll split this up like so:
250  //
251  // rsync @src:dir /tmp/tmpdir
252  // rsync /tmp/tmpdir/dir @dest:location
253  //
254  // The result is that everything in 'dir' is copied to @dest,
255  // and ends up in 'location/dir'.
256  //
257  // 3. Copy the contents of a directory. We will split this
258  // up as follows:
259  //
260  // rsync @src:dir/ /tmp/tmpdir
261  // rsync /tmp/tmpdir/ @dest:location
262  //
263  // After the first rsync, everything in 'dir' will end up in
264  // tmpdir. The second rsync copies everything in tmpdir to
265  // @dest:location without creating an encapsulating folder
266  // in the destination (i.e. there is no 'tmpdir' in the destination).
267  //
268  // All three of these cases need to be handled correctly in order
269  // to ensure the correct results. In all cases the first
270  // rsync always copies to $tmpDir, however the second rsync has
271  // two cases that depend on the source path. If the source path ends
272  // in /, the contents of a directory have been copied to $tmpDir, and
273  // the contents of $tmpDir must be copied to the destination. Otherwise,
274  // a specific file or directory has been copied to $tmpDir and that
275  // specific item, identified by basename($source_path) must be copied to
276  // the destination.
277 
278  $putInTmpPath = drush_tempdir();
279  $getFromTmpPath = "$putInTmpPath/";
280  if (substr($source_path, -1) !== '/') {
281  $getFromTmpPath .= basename($source_path);
282  }
283 
284  // Copy from the source to the temporary location. Exit on failure.
285  $values = drush_invoke_process('@self', 'core-rsync', array($source, $putInTmpPath), $options);
286  if ($values['error'] != 0) {
287  return FALSE;
288  }
289 
290  // Copy from the temporary location to the final destination.
291  $values = drush_invoke_process('@self', 'core-rsync', array($getFromTmpPath, $destination), $options);
292 
293  return $values['error'] == 0;
294 }

File

doxygen/html/rsync_8core_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/rsync.core.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">rsync.core.inc</div>  </div>
</div><!--header-->
<div class="contents">
<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;</div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;use <a class="code" href="classDrush_1_1Log_1_1LogLevel.html">Drush\Log\LogLevel</a>;</div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</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"> * Implements COMMAND hook init.</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="keyword">function</span> drush_core_rsync_init() {</div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;  <span class="comment">// Try to get @self defined when --uri was not provided.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;  drush_bootstrap_max(DRUSH_BOOTSTRAP_DRUPAL_SITE);</div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;}</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">/**</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * A command callback.</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">   16</span>&#160;<span class="comment"> * @param source</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *   A site alias (&quot;@dev&quot;) or site specification (&quot;/path/to/drupal#mysite.com&quot;)</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *   followed by an optional path (&quot;:path/to/sync&quot;), or any path</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> *   that could be passed to rsync (&quot;user@server.com:/path/to/dir/&quot;).</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * @param destination</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> *   Same format as source.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * @param additional_options</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> *   An array of options that overrides whatever was passed in on</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> *   the command line (like the &#39;process&#39; context, but only for</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> *   the scope of this one call).</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">function</span> drush_core_rsync($source, $destination, $additional_options = array()) {</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;  <span class="comment">// Preflight source in case it defines aliases used by the destination</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;  <a class="code" href="sitealias_8inc.html#aba0142245fe1b01f094d42fb060391b1">_drush_sitealias_preflight_path</a>($source);</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;  <span class="comment">// After preflight, evaluate file paths.  We evaluate destination paths first, because</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;  <span class="comment">// there is a first-one-wins policy with --exclude-paths, and we want --target-command-specific</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;  <span class="comment">// to take precedence over --source-command-specific.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;  $destination_settings = <a class="code" href="sitealias_8inc.html#ad847d30de6caee61a30ebc2059f9ad5a">drush_sitealias_evaluate_path</a>($destination, $additional_options, FALSE, <span class="stringliteral">&quot;rsync&quot;</span>, <span class="stringliteral">&#39;target-&#39;</span>);</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;  $source_settings = <a class="code" href="sitealias_8inc.html#ad847d30de6caee61a30ebc2059f9ad5a">drush_sitealias_evaluate_path</a>($source, $additional_options, FALSE, <span class="stringliteral">&quot;rsync&quot;</span>, <span class="stringliteral">&#39;source-&#39;</span>);</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;  $source_path = $source_settings[<span class="stringliteral">&#39;evaluated-path&#39;</span>];</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;  $destination_path = $destination_settings[<span class="stringliteral">&#39;evaluated-path&#39;</span>];</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;  <span class="keywordflow">if</span> (!isset($source_settings)) {</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="keywordflow">return</span> <a class="code" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4">drush_set_error</a>(<span class="stringliteral">&#39;DRUSH_BAD_PATH&#39;</span>, <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Could not evaluate source path !path.&#39;</span>, array(<span class="stringliteral">&#39;!path&#39;</span> =&gt; $source)));</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">if</span> (!isset($destination_settings)) {</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <span class="keywordflow">return</span> <a class="code" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4">drush_set_error</a>(<span class="stringliteral">&#39;DRUSH_BAD_PATH&#39;</span>, <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&#39;Could not evaluate destination path !path.&#39;</span>, array(<span class="stringliteral">&#39;!path&#39;</span> =&gt; $destination)));</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;</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  <span class="comment">// If the user path is the same for the source and the destination, then</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  <span class="comment">// always add a slash to the end of the source.  If the user path is not</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  <span class="comment">// the same in the source and the destination, then you need to know how</span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  <span class="comment">// rsync paths work, and put on the trailing &#39;/&#39; if you want it.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  <span class="keywordflow">if</span> ($source_settings[<span class="stringliteral">&#39;user-path&#39;</span>] == $destination_settings[<span class="stringliteral">&#39;user-path&#39;</span>]) {</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    $source_path .= <span class="charliteral">&#39;/&#39;</span>;</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">// Prompt for confirmation. This is destructive.</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</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="l00054"></a><span class="lineno">   54</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">&quot;You will delete files in !target and replace with data from !source&quot;</span>, array(<span class="stringliteral">&#39;!source&#39;</span> =&gt; $source_path, <span class="stringliteral">&#39;!target&#39;</span> =&gt; $destination_path)));</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</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>(<span class="stringliteral">&#39;Do you really want to continue?&#39;</span>))) {</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</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="l00057"></a><span class="lineno">   57</span>&#160;    }</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;</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  <span class="comment">// Next, check to see if both the source and the destination are remote.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;  <span class="comment">// If so, then we&#39;ll process this as an rsync from source to local,</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;  <span class="comment">// followed by an rsync from local to the destination.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;  <span class="keywordflow">if</span> (<a class="code" href="sitealias_8inc.html#a5437d4bdf307bcc37cd15e903b3d99a9">drush_sitealias_is_remote_site</a>($source_settings) &amp;&amp; <a class="code" href="sitealias_8inc.html#a5437d4bdf307bcc37cd15e903b3d99a9">drush_sitealias_is_remote_site</a>($destination_settings)) {</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keywordflow">return</span> _drush_core_rsync_both_remote($source, $destination, $additional_options, $source_path);</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">// Exclude settings is the default only when both the source and</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;  <span class="comment">// the destination are aliases or site names.  Therefore, include</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  <span class="comment">// settings will be the default whenever either the source or the</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;  <span class="comment">// destination contains a : or a /.</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  $include_settings_is_default = (strpos($source . $destination, <span class="charliteral">&#39;:&#39;</span>) !== FALSE) || (strpos($source . $destination, <span class="charliteral">&#39;/&#39;</span>) !== FALSE);</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;  $options = _drush_build_rsync_options($additional_options, $include_settings_is_default);</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="comment">// Get all of the args and options that appear after the command name.</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  $original_args = <a class="code" href="command_8inc.html#a272d98da256f7ae2988f3aa7cb6b464b">drush_get_original_cli_args_and_options</a>();</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;  <span class="keywordflow">foreach</span> ($original_args as $original_option) {</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <span class="keywordflow">if</span> ($original_option{0} == <span class="charliteral">&#39;-&#39;</span>) {</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;      $options .= <span class="charliteral">&#39; &#39;</span> . $original_option;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    }</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;  <a class="code" href="backend_8inc.html#ad8040331b08464a2a48b7ac8a00ed13c">drush_backend_set_result</a>($destination_path);</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;  <span class="comment">// Go ahead and call rsync with the paths we determined</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;  <span class="keywordflow">return</span> drush_core_exec_rsync($source_path, $destination_path, $options);</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;}</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">   88</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment"> * Make a direct call to rsync after the source and destination paths</span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment"> * have been evaluated.</span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment"> * @param $source</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment"> *   Any path that can be passed to rsync.</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment"> * @param $destination</span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment"> *   Any path that can be passed to rsync.</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment"> * @param $additional_options</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"> *   An array of options that overrides whatever was passed in on the command</span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment"> *   line (like the &#39;process&#39; context, but only for the scope of this one</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"> *   call).</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment"> * @param $include_settings_is_default</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment"> *   If TRUE, then settings.php will be transferred as part of the rsync unless</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment"> *   --exclude-conf is specified.  If FALSE, then settings.php will be excluded</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"> *   from the transfer unless --include-conf is specified.</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment"> * @param $live_output</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"> *   If TRUE, output goes directly to the terminal using system(). If FALSE,</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment"> *   rsync is executed with drush_shell_exec() with output in</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment"> *   drush_shell_exec_output().</span></div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment"> * @return</span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment"> *   TRUE on success, FALSE on failure.</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="keyword">function</span> drush_core_call_rsync($source, $destination, $additional_options = array(), $include_settings_is_default = TRUE, $live_output = TRUE) {</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;  $options = _drush_build_rsync_options($additional_options, $include_settings_is_default);</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;  <span class="keywordflow">return</span> drush_core_exec_rsync($source, $destination, $options, $additional_options, $live_output);</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="keyword">function</span> drush_core_exec_rsync($source, $destination, $options, $additional_options = array(), $live_output = TRUE) {</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;  $ssh_options = <a class="code" href="context_8inc.html#a559008f6decb23108b83e704208e415e">drush_get_option_override</a>($additional_options, <span class="stringliteral">&#39;ssh-options&#39;</span>, <span class="stringliteral">&#39;&#39;</span>);</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;  $exec = <span class="stringliteral">&quot;rsync -e &#39;ssh $ssh_options&#39; $options $source $destination&quot;</span>;</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;  <span class="keywordflow">if</span> ($live_output) {</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    $exec_result = <a class="code" href="group__commandwrappers.html#ga9199c80718bb0497997bd9f7b783911a">drush_op_system</a>($exec);</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    $result = ($exec_result == 0);</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;  }</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;    $result = <a class="code" href="group__commandwrappers.html#gafd358ceac1286dbdd141ff2b8eb7d556">drush_shell_exec</a>($exec);</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;  }</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;  <span class="keywordflow">if</span> (!$result) {</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;    <a class="code" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4">drush_set_error</a>(<span class="stringliteral">&#39;DRUSH_RSYNC_FAILED&#39;</span>, <a class="code" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96">dt</a>(<span class="stringliteral">&quot;Could not rsync from !source to !dest&quot;</span>, array(<span class="stringliteral">&#39;!source&#39;</span> =&gt; $source, <span class="stringliteral">&#39;!dest&#39;</span> =&gt; $destination)));</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;  }</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">return</span> $result;</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;</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="keyword">function</span> _drush_build_rsync_options($additional_options, $include_settings_is_default = TRUE) {</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;  $options = <span class="stringliteral">&#39;&#39;</span>;</div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;  <span class="comment">// Exclude vcs reserved files.</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;  <span class="keywordflow">if</span> (!_drush_rsync_option_exists(<span class="stringliteral">&#39;include-vcs&#39;</span>, $additional_options)) {</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;    $vcs_files = <a class="code" href="drush_8inc.html#aa61cd59315f7a89a8c7df8649f480a31">drush_version_control_reserved_files</a>();</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    <span class="keywordflow">foreach</span> ($vcs_files as $file) {</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;      $options .= <span class="stringliteral">&#39; --exclude=&quot;&#39;</span>.$file.<span class="charliteral">&#39;&quot;&#39;</span>;</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;    }</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;  }</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;    unset($additional_options[<span class="stringliteral">&#39;include-vcs&#39;</span>]);</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;</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;  $mode = <span class="stringliteral">&#39;-akz&#39;</span>;</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;  <span class="comment">// Process --include-paths and --exclude-paths options the same way</span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;  <span class="keywordflow">foreach</span> (array(<span class="stringliteral">&#39;include&#39;</span>, <span class="stringliteral">&#39;exclude&#39;</span>) as $include_exclude) {</div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;    <span class="comment">// Get the option --include-paths or --exclude-paths and explode to an array of paths</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;    <span class="comment">// that we will translate into an --include or --exclude option to pass to rsync</span></div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;    $inc_ex_path = explode(PATH_SEPARATOR, <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>($include_exclude . <span class="stringliteral">&#39;-paths&#39;</span>, <span class="stringliteral">&#39;&#39;</span>));</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;    <span class="keywordflow">foreach</span> ($inc_ex_path as $one_path_to_inc_ex) {</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;      <span class="keywordflow">if</span> (!empty($one_path_to_inc_ex)) {</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;        $options .= <span class="stringliteral">&#39; --&#39;</span> . $include_exclude . <span class="stringliteral">&#39;=&quot;&#39;</span> . $one_path_to_inc_ex . <span class="charliteral">&#39;&quot;&#39;</span>;</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;    <span class="comment">// Remove stuff inserted by evaluate path</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;    unset($additional_options[$include_exclude . <span class="stringliteral">&#39;-paths&#39;</span>]);</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;    unset($additional_options[$include_exclude . <span class="stringliteral">&#39;-files-processed&#39;</span>]);</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;  <span class="comment">// drush_core_rsync passes in $include_settings_is_default such that</span></div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;  <span class="comment">// &#39;exclude-conf&#39; is the default when syncing from one alias to</span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;  <span class="comment">// another, and &#39;include-conf&#39; is the default when a path component</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;  <span class="comment">// is included.</span></div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;  <span class="keywordflow">if</span> ($include_settings_is_default ? _drush_rsync_option_exists(<span class="stringliteral">&#39;exclude-conf&#39;</span>, $additional_options) : !_drush_rsync_option_exists(<span class="stringliteral">&#39;include-conf&#39;</span>, $additional_options)) {</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;    $options .= <span class="stringliteral">&#39; --exclude=&quot;settings.php&quot;&#39;</span>;</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;    unset($additional_options[<span class="stringliteral">&#39;exclude-conf&#39;</span>]);</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;  <span class="keywordflow">if</span> (_drush_rsync_option_exists(<span class="stringliteral">&#39;exclude-sites&#39;</span>, $additional_options)) {</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;    $options .= <span class="stringliteral">&#39; --include=&quot;sites/all&quot; --exclude=&quot;sites/*&quot;&#39;</span>;</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;    unset($additional_options[<span class="stringliteral">&#39;exclude-sites&#39;</span>]);</div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;  }</div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;  <span class="keywordflow">if</span> (_drush_rsync_option_exists(<span class="stringliteral">&#39;mode&#39;</span>, $additional_options)) {</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;    $mode = <span class="stringliteral">&quot;-&quot;</span> . <a class="code" href="context_8inc.html#a559008f6decb23108b83e704208e415e">drush_get_option_override</a>($additional_options, <span class="stringliteral">&#39;mode&#39;</span>);</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;    unset($additional_options[<span class="stringliteral">&#39;mode&#39;</span>]);</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;  }</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;  <span class="keywordflow">if</span> (<a class="code" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5">drush_get_context</a>(<span class="stringliteral">&#39;DRUSH_VERBOSE&#39;</span>)) {</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;    <span class="comment">// the drush_op() will be verbose about the command that gets executed.</span></div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;    $mode .= <span class="charliteral">&#39;v&#39;</span>;</div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;    $options .= <span class="stringliteral">&#39; --stats --progress&#39;</span>;</div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;  }</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;  <span class="comment">// Check if the user has set $options[&#39;rsync-version&#39;] to enable rsync legacy version support.</span></div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;  <span class="comment">// Drush was written for rsync 2.6.9 or later, so assume that version if nothing was explicitly set.</span></div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;  $rsync_version = <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>(array(<span class="stringliteral">&#39;rsync-version&#39;</span>,<span class="stringliteral">&#39;source-rsync-version&#39;</span>,<span class="stringliteral">&#39;target-rsync-version&#39;</span>), <span class="stringliteral">&#39;2.6.9&#39;</span>);</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;  $options_to_exclude = array(<span class="stringliteral">&#39;ssh-options&#39;</span>);</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;  <span class="keywordflow">foreach</span> ($additional_options as $test_option =&gt; $value) {</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;    <span class="comment">// Downgrade some options for older versions of rsync</span></div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;    <span class="keywordflow">if</span> ($test_option == <span class="stringliteral">&#39;remove-source-files&#39;</span>) {</div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;      <span class="keywordflow">if</span> (version_compare($rsync_version, <span class="stringliteral">&#39;2.6.4&#39;</span>, <span class="charliteral">&#39;&lt;&#39;</span>)) {</div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;        $test_option = NULL;</div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;        <a class="code" href="group__logging.html#ga47324b65808524558a488916b150dd51">drush_log</a>(<span class="stringliteral">&#39;Rsync does not support --remove-sent-files prior to version 2.6.4; some temporary files may remain undeleted.&#39;</span>, LogLevel::WARNING);</div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;      }</div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;      elseif (version_compare($rsync_version, <span class="stringliteral">&#39;2.6.9&#39;</span>, <span class="charliteral">&#39;&lt;&#39;</span>)) {</div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;        $test_option = <span class="stringliteral">&#39;remove-sent-files&#39;</span>;</div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;      }</div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;    }</div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;    <span class="keywordflow">if</span> ((isset($test_option)) &amp;&amp; !in_array($test_option, $options_to_exclude) &amp;&amp; (isset($value)  &amp;&amp; !is_array($value))) {</div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;      <span class="keywordflow">if</span> (($value === TRUE) || (!isset($value))) {</div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;        $options .= <span class="stringliteral">&quot; --$test_option&quot;</span>;</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;      <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;        $options .= <span class="stringliteral">&quot; --$test_option=&quot;</span> . escapeshellarg($value);</div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;      }</div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;    }</div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;  }</div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;</div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;  <span class="keywordflow">return</span> $mode . $options;</div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;}</div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;</div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;<span class="keyword">function</span> _drush_rsync_option_exists($option, $additional_options) {</div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;  <span class="keywordflow">if</span> (array_key_exists($option, $additional_options)) {</div>
<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;    <span class="keywordflow">return</span> TRUE;</div>
<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;  }</div>
<div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;    <span class="keywordflow">return</span> <a class="code" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8">drush_get_option</a>($option, FALSE);</div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;  }</div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;}</div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;<span class="comment"> * Handle an rsync operation from a remote site to a remote</span></div>
<div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="comment"> * site by first rsync&#39;ing to a local location, and then</span></div>
<div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;<span class="comment"> * copying that location to its final destination.</span></div>
<div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;<span class="keyword">function</span> _drush_core_rsync_both_remote($source, $destination, $additional_options, $source_path) {</div>
<div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;  $options = $additional_options + <a class="code" href="group__dispatching.html#ga9b1a98376983ee529fc868ef4280b12d">drush_redispatch_get_options</a>();</div>
<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;</div>
<div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;  <span class="comment">// Make a temporary directory to copy to.  There are three</span></div>
<div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;  <span class="comment">// cases to consider:</span></div>
<div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;  <span class="comment">//</span></div>
<div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;  <span class="comment">// 1. rsync @src:file.txt @dest:location</span></div>
<div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;  <span class="comment">// 2. rsync @src:dir @dest:location</span></div>
<div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;  <span class="comment">// 3. rsync @src:dir/ @dest:location</span></div>
<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;  <span class="comment">//</span></div>
<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;  <span class="comment">// We will explain each of these in turn.</span></div>
<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;  <span class="comment">//</span></div>
<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;  <span class="comment">// 1. Copy a single file.  We&#39;ll split this up like so:</span></div>
<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;  <span class="comment">//</span></div>
<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;  <span class="comment">//    rsync @src:file.txt /tmp/tmpdir</span></div>
<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;  <span class="comment">//    rsync /tmp/tmpdir/file.txt @dest:location</span></div>
<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;  <span class="comment">//</span></div>
<div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;  <span class="comment">// Since /tmp/tmpdir is empty, we could also rsync from</span></div>
<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;  <span class="comment">// &#39;/tmp/tmpdir/&#39; if we wished.</span></div>
<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;  <span class="comment">//</span></div>
<div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;  <span class="comment">// 2. Copy a directory. A directory with the same name</span></div>
<div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;  <span class="comment">// is copied to the destination.  We&#39;ll split this up like so:</span></div>
<div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;  <span class="comment">//</span></div>
<div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;  <span class="comment">//    rsync @src:dir /tmp/tmpdir</span></div>
<div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;  <span class="comment">//    rsync /tmp/tmpdir/dir @dest:location</span></div>
<div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;  <span class="comment">//</span></div>
<div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;  <span class="comment">// The result is that everything in &#39;dir&#39; is copied to @dest,</span></div>
<div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;  <span class="comment">// and ends up in &#39;location/dir&#39;.</span></div>
<div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;  <span class="comment">//</span></div>
<div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;  <span class="comment">// 3. Copy the contents of a directory.  We will split this</span></div>
<div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;  <span class="comment">// up as follows:</span></div>
<div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;  <span class="comment">//</span></div>
<div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;  <span class="comment">//    rsync @src:dir/ /tmp/tmpdir</span></div>
<div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;  <span class="comment">//    rsync /tmp/tmpdir/ @dest:location</span></div>
<div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;  <span class="comment">//</span></div>
<div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;  <span class="comment">// After the first rsync, everything in &#39;dir&#39; will end up in</span></div>
<div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;  <span class="comment">// tmpdir.  The second rsync copies everything in tmpdir to</span></div>
<div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;  <span class="comment">// @dest:location without creating an encapsulating folder</span></div>
<div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;  <span class="comment">// in the destination (i.e. there is no &#39;tmpdir&#39; in the destination).</span></div>
<div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;  <span class="comment">//</span></div>
<div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;  <span class="comment">// All three of these cases need to be handled correctly in order</span></div>
<div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;  <span class="comment">// to ensure the correct results.  In all cases the first</span></div>
<div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;  <span class="comment">// rsync always copies to $tmpDir, however the second rsync has</span></div>
<div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;  <span class="comment">// two cases that depend on the source path.  If the source path ends</span></div>
<div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;  <span class="comment">// in /, the contents of a directory have been copied to $tmpDir, and</span></div>
<div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;  <span class="comment">// the contents of $tmpDir must be copied to the destination.  Otherwise,</span></div>
<div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;  <span class="comment">// a specific file or directory has been copied to $tmpDir and that</span></div>
<div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;  <span class="comment">// specific item, identified by basename($source_path) must be copied to</span></div>
<div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;  <span class="comment">// the destination.</span></div>
<div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;</div>
<div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;  $putInTmpPath = <a class="code" href="group__filesystemfunctions.html#ga883d28ed54603b2d268902cec2379804">drush_tempdir</a>();</div>
<div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;  $getFromTmpPath = <span class="stringliteral">&quot;$putInTmpPath/&quot;</span>;</div>
<div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;  <span class="keywordflow">if</span> (substr($source_path, -1) !== <span class="charliteral">&#39;/&#39;</span>) {</div>
<div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;    $getFromTmpPath .= basename($source_path);</div>
<div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;  }</div>
<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;</div>
<div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;  <span class="comment">// Copy from the source to the temporary location. Exit on failure.</span></div>
<div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;  $values = <a class="code" href="group__dispatching.html#ga125471885af052278a0874446b332cf9">drush_invoke_process</a>(<span class="stringliteral">&#39;@self&#39;</span>, <span class="stringliteral">&#39;core-rsync&#39;</span>, array($source, $putInTmpPath), $options);</div>
<div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;  <span class="keywordflow">if</span> ($values[<span class="stringliteral">&#39;error&#39;</span>] != 0) {</div>
<div class="line"><a name="l00287"></a><span class="lineno">  287</span>&#160;    <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160;  }</div>
<div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;</div>
<div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;  <span class="comment">// Copy from the temporary location to the final destination.</span></div>
<div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;  $values = <a class="code" href="group__dispatching.html#ga125471885af052278a0874446b332cf9">drush_invoke_process</a>(<span class="stringliteral">&#39;@self&#39;</span>, <span class="stringliteral">&#39;core-rsync&#39;</span>, array($getFromTmpPath, $destination), $options);</div>
<div class="line"><a name="l00292"></a><span class="lineno">  292</span>&#160;</div>
<div class="line"><a name="l00293"></a><span class="lineno">  293</span>&#160;  <span class="keywordflow">return</span> $values[<span class="stringliteral">&#39;error&#39;</span>] == 0;</div>
<div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 2 2016 07:28:54 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>