Drush: commands/core/drupal/batch_6.inc Source File

  1. 7.x doxygen/html/batch__6_8inc_source.html
  2. master doxygen/html/batch__6_8inc_source.html
batch_6.inc
Go to the documentation of this file.
1 <?php
2 /**
3  * @file
4  * Drupal 6 engine for the Batch API
5  */
6 
8 
9 /**
10  * Main loop for the Drush batch API.
11  *
12  * Saves a record of the batch into the database, and progressively call $command to
13  * process the operations.
14  *
15  * @param command
16  * The command to call to process the batch.
17  *
18  */
19 function _drush_backend_batch_process($command = 'batch-process', $args, $options) {
20  $batch =& batch_get();
21 
22  if (isset($batch)) {
23  $process_info = array(
24  'current_set' => 0,
25  );
26  $batch += $process_info;
27 
28  // Initiate db storage in order to get a batch id. We have to provide
29  // at least an empty string for the (not null) 'token' column.
30  db_query("INSERT INTO {batch} (token, timestamp) VALUES ('', %d)", time());
31  $batch['id'] = db_last_insert_id('batch', 'bid');
32  $args[] = $batch['id'];
33 
34  // Actually store the batch data and the token generated form the batch id.
35  db_query("UPDATE {batch} SET token = '%s', batch = '%s' WHERE bid = %d", drupal_get_token($batch['id']), serialize($batch), $batch['id']);
36 
37  $finished = FALSE;
38 
39  while (!$finished) {
40  $data = drush_invoke_process('@self', $command, $args, $options);
41  $finished = drush_get_error() || !$data || (isset($data['context']['drush_batch_process_finished']) && $data['context']['drush_batch_process_finished'] == TRUE);
42  }
43  }
44 }
45 
46 /**
47  * Initialize the batch command and call the worker function.
48  *
49  * Loads the batch record from the database and sets up the requirements
50  * for the worker, such as registering the shutdown function.
51  *
52  * @param id
53  * The batch id of the batch being processed.
54  */
55 function _drush_batch_command($id) {
56  $batch =& batch_get();
57  // Retrieve the current state of batch from db.
58  if ($data = db_result(db_query("SELECT batch FROM {batch} WHERE bid = %d", $id))) {
59  $batch = unserialize($data);
60  }
61  else {
62  return FALSE;
63  }
64  if (!isset($batch['running'])) {
65  $batch['running'] = TRUE;
66  }
67 
68  // Register database update for end of processing.
69  register_shutdown_function('_drush_batch_shutdown');
70 
71  if (_drush_batch_worker()) {
73  }
74 }
75 
76 /**
77  * Process batch operations
78  *
79  * Using the current $batch process each of the operations until the batch
80  * has been completed or half of the available memory for the process has been
81  * reached.
82  */
83 function _drush_batch_worker() {
84  $batch =& batch_get();
85  $current_set =& _batch_current_set();
86  $set_changed = TRUE;
87 
88  timer_start('batch_processing');
89 
90  while (!$current_set['success']) {
91  // If this is the first time we iterate this batch set in the current
92  // request, we check if it requires an additional file for functions
93  // definitions.
94  if ($set_changed && isset($current_set['file']) && is_file($current_set['file'])) {
95  include_once($current_set['file']);
96  }
97 
98  $finished = 1;
99  $task_message = '';
100  if ((list($function, $args) = reset($current_set['operations'])) && function_exists($function)) {
101  // Build the 'context' array, execute the function call,
102  // and retrieve the user message.
103  $batch_context = array('sandbox' => &$current_set['sandbox'], 'results' => &$current_set['results'], 'finished' => &$finished, 'message' => &$task_message);
104  // Magic wrap to catch changes to 'message' key.
105  $batch_context = new DrushBatchContext($batch_context);
106  // Process the current operation.
107  call_user_func_array($function, array_merge($args, array(&$batch_context)));
108  $finished = $batch_context['finished'];
109  }
110 
111  if ($finished >= 1) {
112  // Make sure this step isn't counted double when computing $current.
113  $finished = 0;
114  // Remove the operation and clear the sandbox.
115  array_shift($current_set['operations']);
116  $current_set['sandbox'] = array();
117  }
118 
119  // If the batch set is completed, browse through the remaining sets,
120  // executing 'control sets' (stored form submit handlers) along the way -
121  // this might in turn insert new batch sets.
122  // Stop when we find a set that actually has operations.
123  $set_changed = FALSE;
124  $old_set = $current_set;
125  while (empty($current_set['operations']) && ($current_set['success'] = TRUE) && _batch_next_set()) {
126  $current_set =& _batch_current_set();
127  $set_changed = TRUE;
128  }
129  // At this point, either $current_set is a 'real' batch set (has operations),
130  // or all sets have been completed.
131 
132 
133  // TODO - replace with memory check!
134  // If we're in progressive mode, stop after 1 second.
135  if ((memory_get_usage() * 2) >= drush_memory_limit()) {
136  drush_log(dt("Batch process has consumed in excess of 50% of available memory. Starting new thread"), LogLevel::BATCH);
137  break;
138  }
139  }
140 
141  // Gather progress information.
142 
143  // Reporting 100% progress will cause the whole batch to be considered
144  // processed. If processing was paused right after moving to a new set,
145  // we have to use the info from the new (unprocessed) one.
146  if ($set_changed && isset($current_set['operations'])) {
147  // Processing will continue with a fresh batch set.
148  $remaining = count($current_set['operations']);
149  $total = $current_set['total'];
150  $task_message = '';
151  }
152  else {
153  $remaining = count($old_set['operations']);
154  $total = $old_set['total'];
155  }
156 
157  $current = $total - $remaining + $finished;
158  $percentage = $total ? floor($current / $total * 100) : 100;
159 
160  return ($percentage == 100);
161 }
162 
163 /**
164  * End the batch processing:
165  * Call the 'finished' callbacks to allow custom handling of results,
166  * and resolve page redirection.
167  */
169  $batch =& batch_get();
170 
171  // Execute the 'finished' callbacks for each batch set.
172  foreach ($batch['sets'] as $key => $batch_set) {
173  if (isset($batch_set['finished'])) {
174  // Check if the set requires an additional file for functions definitions.
175  if (isset($batch_set['file']) && is_file($batch_set['file'])) {
176  include_once($batch_set['file']);
177  }
178  if (function_exists($batch_set['finished'])) {
179  $batch_set['finished']($batch_set['success'], $batch_set['results'], $batch_set['operations']);
180  }
181  }
182  }
183 
184  // Cleanup the batch table and unset the global $batch variable.
185  db_query("DELETE FROM {batch} WHERE bid = %d", $batch['id']);
186  $_batch = $batch;
187  $batch = NULL;
188  drush_set_option('drush_batch_process_finished', TRUE);
189 }
190 
191 /**
192  * Shutdown function: store the batch data for next request,
193  * or clear the table if the batch is finished.
194  */
196  if ($batch = batch_get()) {
197  db_query("UPDATE {batch} SET batch = '%s' WHERE bid = %d", serialize($batch), $batch['id']);
198  }
199 }

File

doxygen/html/batch__6_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/drupal/batch_6.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><li class="navelem"><a class="el" href="dir_124c2f0cfa86b0affb712ae9b365039b.html">drupal</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">batch_6.inc</div>  </div>
</div><!--header-->
<div class="contents">
<a href="batch__6_8inc.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;&lt;?php<span class="comment"></span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * @file</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *   Drupal 6 engine for the Batch API</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;</div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;use <a class="code" href="classDrush_1_1Log_1_1LogLevel.html">Drush\Log\LogLevel</a>;</div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * Main loop for the Drush batch API.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * Saves a record of the batch into the database, and progressively call $command to</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * process the operations.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * @param command</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *    The command to call to process the batch.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="code" href="batch__6_8inc.html#aaf9128a2dbd643871368ffdc18216a76">   19</a></span>&#160;<span class="keyword">function</span> <a class="code" href="commands_2core_2drupal_2batch_8inc.html#aaf9128a2dbd643871368ffdc18216a76">_drush_backend_batch_process</a>($command = <span class="stringliteral">&#39;batch-process&#39;</span>, $args, $options) {</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;  $batch =&amp; batch_get();</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;  <span class="keywordflow">if</span> (isset($batch)) {</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    $process_info = array(</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;      <span class="stringliteral">&#39;current_set&#39;</span> =&gt; 0,</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    );</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    $batch += $process_info;</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <span class="comment">// Initiate db storage in order to get a batch id. We have to provide</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    <span class="comment">// at least an empty string for the (not null) &#39;token&#39; column.</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    db_query(<span class="stringliteral">&quot;INSERT INTO {batch} (token, timestamp) VALUES (&#39;&#39;, %d)&quot;</span>, time());</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    $batch[<span class="stringliteral">&#39;id&#39;</span>] = db_last_insert_id(<span class="stringliteral">&#39;batch&#39;</span>, <span class="stringliteral">&#39;bid&#39;</span>);</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    $args[] = $batch[<span class="stringliteral">&#39;id&#39;</span>];</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">// Actually store the batch data and the token generated form the batch id.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    db_query(<span class="stringliteral">&quot;UPDATE {batch} SET token = &#39;%s&#39;, batch = &#39;%s&#39; WHERE bid = %d&quot;</span>, drupal_get_token($batch[<span class="stringliteral">&#39;id&#39;</span>]), serialize($batch), $batch[<span class="stringliteral">&#39;id&#39;</span>]);</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    $finished = FALSE;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="keywordflow">while</span> (!$finished) {</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;      $data = <a class="code" href="group__dispatching.html#ga125471885af052278a0874446b332cf9">drush_invoke_process</a>(<span class="stringliteral">&#39;@self&#39;</span>, $command, $args, $options);</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;      $finished = <a class="code" href="group__errorhandling.html#ga33fe8456b3dc49a0e28e7f63692a0d44">drush_get_error</a>() || !$data || (isset($data[<span class="stringliteral">&#39;context&#39;</span>][<span class="stringliteral">&#39;drush_batch_process_finished&#39;</span>]) &amp;&amp; $data[<span class="stringliteral">&#39;context&#39;</span>][<span class="stringliteral">&#39;drush_batch_process_finished&#39;</span>] == TRUE);</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    }</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;  }</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;}</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"> * Initialize the batch command and call the worker function.</span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"> * Loads the batch record from the database and sets up the requirements</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment"> * for the worker, such as registering the shutdown function.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment"> * @param id</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment"> *   The batch id of the batch being processed.</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="batch__6_8inc.html#afa58efbd11be795ce39d4d14f4ac35e0">   55</a></span>&#160;<span class="keyword">function</span> <a class="code" href="commands_2core_2drupal_2batch_8inc.html#afa58efbd11be795ce39d4d14f4ac35e0">_drush_batch_command</a>($id) {</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;  $batch =&amp; batch_get();</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  <span class="comment">// Retrieve the current state of batch from db.</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  <span class="keywordflow">if</span> ($data = db_result(db_query(<span class="stringliteral">&quot;SELECT batch FROM {batch} WHERE bid = %d&quot;</span>, $id))) {</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    $batch = unserialize($data);</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;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;  }</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;  <span class="keywordflow">if</span> (!isset($batch[<span class="stringliteral">&#39;running&#39;</span>])) {</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    $batch[<span class="stringliteral">&#39;running&#39;</span>] = TRUE;</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;  }</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;  <span class="comment">// Register database update for end of processing.</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  register_shutdown_function(<span class="stringliteral">&#39;_drush_batch_shutdown&#39;</span>);</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  <span class="keywordflow">if</span> (<a class="code" href="commands_2core_2drupal_2batch_8inc.html#a10c0d541fd31cfed1eed4caed37e30fa">_drush_batch_worker</a>()) {</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <a class="code" href="commands_2core_2drupal_2batch_8inc.html#a1e3ba040027e50c90258295d7a70aec0">_drush_batch_finished</a>();</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;  }</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;}</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment"> * Process batch operations</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"> * Using the current $batch process each of the operations until the batch</span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment"> * has been completed or half of the available memory for the process has been</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"> * reached.</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="code" href="batch__6_8inc.html#a10c0d541fd31cfed1eed4caed37e30fa">   83</a></span>&#160;<span class="keyword">function</span> <a class="code" href="commands_2core_2drupal_2batch_8inc.html#a10c0d541fd31cfed1eed4caed37e30fa">_drush_batch_worker</a>() {</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;  $batch =&amp; batch_get();</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;  $current_set =&amp; _batch_current_set();</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;  $set_changed = TRUE;</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;  timer_start(<span class="stringliteral">&#39;batch_processing&#39;</span>);</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;  <span class="keywordflow">while</span> (!$current_set[<span class="stringliteral">&#39;success&#39;</span>]) {</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    <span class="comment">// If this is the first time we iterate this batch set in the current</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    <span class="comment">// request, we check if it requires an additional file for functions</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    <span class="comment">// definitions.</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    <span class="keywordflow">if</span> ($set_changed &amp;&amp; isset($current_set[<span class="stringliteral">&#39;file&#39;</span>]) &amp;&amp; is_file($current_set[<span class="stringliteral">&#39;file&#39;</span>])) {</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;      include_once($current_set[<span class="stringliteral">&#39;file&#39;</span>]);</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    }</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;    $finished = 1;</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    $task_message = <span class="stringliteral">&#39;&#39;</span>;</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    <span class="keywordflow">if</span> ((list($function, $args) = reset($current_set[<span class="stringliteral">&#39;operations&#39;</span>])) &amp;&amp; function_exists($function)) {</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;      <span class="comment">// Build the &#39;context&#39; array, execute the function call,</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;      <span class="comment">// and retrieve the user message.</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;      $batch_context = array(<span class="stringliteral">&#39;sandbox&#39;</span> =&gt; &amp;$current_set[<span class="stringliteral">&#39;sandbox&#39;</span>], <span class="stringliteral">&#39;results&#39;</span> =&gt; &amp;$current_set[<span class="stringliteral">&#39;results&#39;</span>], <span class="stringliteral">&#39;finished&#39;</span> =&gt; &amp;$finished, <span class="stringliteral">&#39;message&#39;</span> =&gt; &amp;$task_message);</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;      <span class="comment">// Magic wrap to catch changes to &#39;message&#39; key.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;      $batch_context = <span class="keyword">new</span> <a class="code" href="classDrushBatchContext.html">DrushBatchContext</a>($batch_context);</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;      <span class="comment">// Process the current operation.</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;      call_user_func_array($function, array_merge($args, array(&amp;$batch_context)));</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;      $finished = $batch_context[<span class="stringliteral">&#39;finished&#39;</span>];</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;    }</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    <span class="keywordflow">if</span> ($finished &gt;= 1) {</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;      <span class="comment">// Make sure this step isn&#39;t counted double when computing $current.</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;      $finished = 0;</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;      <span class="comment">// Remove the operation and clear the sandbox.</span></div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;      array_shift($current_set[<span class="stringliteral">&#39;operations&#39;</span>]);</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;      $current_set[<span class="stringliteral">&#39;sandbox&#39;</span>] = array();</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;    }</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;    <span class="comment">// If the batch set is completed, browse through the remaining sets,</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;    <span class="comment">// executing &#39;control sets&#39; (stored form submit handlers) along the way -</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    <span class="comment">// this might in turn insert new batch sets.</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    <span class="comment">// Stop when we find a set that actually has operations.</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    $set_changed = FALSE;</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    $old_set = $current_set;</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;    <span class="keywordflow">while</span> (empty($current_set[<span class="stringliteral">&#39;operations&#39;</span>]) &amp;&amp; ($current_set[<span class="stringliteral">&#39;success&#39;</span>] = TRUE) &amp;&amp; _batch_next_set()) {</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;      $current_set =&amp; _batch_current_set();</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;      $set_changed = TRUE;</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="comment">// At this point, either $current_set is a &#39;real&#39; batch set (has operations),</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;    <span class="comment">// or all sets have been completed.</span></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="comment">// TODO - replace with memory check!</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;    <span class="comment">// If we&#39;re in progressive mode, stop after 1 second.</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;    <span class="keywordflow">if</span> ((memory_get_usage() * 2) &gt;= <a class="code" href="drush_8inc.html#a78afaf6bac26a5964c39db973deb0783">drush_memory_limit</a>()) {</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</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;Batch process has consumed in excess of 50% of available memory. Starting new thread&quot;</span>), LogLevel::BATCH);</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;      <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;    }</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;  }</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;  <span class="comment">// Gather progress information.</span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;  <span class="comment">// Reporting 100% progress will cause the whole batch to be considered</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;  <span class="comment">// processed. If processing was paused right after moving to a new set,</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;  <span class="comment">// we have to use the info from the new (unprocessed) one.</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;  <span class="keywordflow">if</span> ($set_changed &amp;&amp; isset($current_set[<span class="stringliteral">&#39;operations&#39;</span>])) {</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;    <span class="comment">// Processing will continue with a fresh batch set.</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;    $remaining = count($current_set[<span class="stringliteral">&#39;operations&#39;</span>]);</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;    $total = $current_set[<span class="stringliteral">&#39;total&#39;</span>];</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;    $task_message = <span class="stringliteral">&#39;&#39;</span>;</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;  }</div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;    $remaining = count($old_set[<span class="stringliteral">&#39;operations&#39;</span>]);</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;    $total = $old_set[<span class="stringliteral">&#39;total&#39;</span>];</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;  }</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;  $current    = $total - $remaining + $finished;</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;  $percentage = $total ? floor($current / $total * 100) : 100;</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="keywordflow">return</span> ($percentage == 100);</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;}</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="comment"> * End the batch processing:</span></div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"> * Call the &#39;finished&#39; callbacks to allow custom handling of results,</span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment"> * and resolve page redirection.</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"><a class="code" href="batch__6_8inc.html#a1e3ba040027e50c90258295d7a70aec0">  168</a></span>&#160;<span class="keyword">function</span> <a class="code" href="commands_2core_2drupal_2batch_8inc.html#a1e3ba040027e50c90258295d7a70aec0">_drush_batch_finished</a>() {</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;  $batch =&amp; batch_get();</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;  <span class="comment">// Execute the &#39;finished&#39; callbacks for each batch set.</span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;  <span class="keywordflow">foreach</span> ($batch[<span class="stringliteral">&#39;sets&#39;</span>] as $key =&gt; $batch_set) {</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;    <span class="keywordflow">if</span> (isset($batch_set[<span class="stringliteral">&#39;finished&#39;</span>])) {</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;      <span class="comment">// Check if the set requires an additional file for functions definitions.</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;      <span class="keywordflow">if</span> (isset($batch_set[<span class="stringliteral">&#39;file&#39;</span>]) &amp;&amp; is_file($batch_set[<span class="stringliteral">&#39;file&#39;</span>])) {</div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;        include_once($batch_set[<span class="stringliteral">&#39;file&#39;</span>]);</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;      }</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;      <span class="keywordflow">if</span> (function_exists($batch_set[<span class="stringliteral">&#39;finished&#39;</span>])) {</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;        $batch_set[<span class="stringliteral">&#39;finished&#39;</span>]($batch_set[<span class="stringliteral">&#39;success&#39;</span>], $batch_set[<span class="stringliteral">&#39;results&#39;</span>], $batch_set[<span class="stringliteral">&#39;operations&#39;</span>]);</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;      }</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;    }</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;  }</div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;</div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;  <span class="comment">// Cleanup the batch table and unset the global $batch variable.</span></div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;  db_query(<span class="stringliteral">&quot;DELETE FROM {batch} WHERE bid = %d&quot;</span>, $batch[<span class="stringliteral">&#39;id&#39;</span>]);</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;  $_batch = $batch;</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;  $batch = NULL;</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;  <a class="code" href="context_8inc.html#aa4b55e2f6174c8b6efaa8f23a0f9e0af">drush_set_option</a>(<span class="stringliteral">&#39;drush_batch_process_finished&#39;</span>, TRUE);</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;}</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment"> * Shutdown function: store the batch data for next request,</span></div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment"> * or clear the table if the batch is finished.</span></div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"><a class="code" href="batch__6_8inc.html#adf332cef87024828da87ac77de54440d">  195</a></span>&#160;<span class="keyword">function</span> <a class="code" href="commands_2core_2drupal_2batch_8inc.html#adf332cef87024828da87ac77de54440d">_drush_batch_shutdown</a>() {</div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;  <span class="keywordflow">if</span> ($batch = batch_get()) {</div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;    db_query(<span class="stringliteral">&quot;UPDATE {batch} SET batch = &#39;%s&#39; WHERE bid = %d&quot;</span>, serialize($batch), $batch[<span class="stringliteral">&#39;id&#39;</span>]);</div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;  }</div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Mar 29 2016 07:27:28 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>