├── .gitignore
├── README.md
├── config.php.dist
├── cli.php
├── style.css
├── DbDiff.php
├── index.php
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
 1 | config.php
 2 | nbproject*
 3 | .buildpath
 4 | .project
 5 | .settings
 6 | .settings/
 7 | /*.bak
 8 | /*~
 9 | mailoutput*
10 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | dbdiff
2 | ======
3 | 
4 | A PHP script to compare MySQL database schemas. 
5 | 
6 | More information available on [the blog post](http://joef.co.uk/blog/2009/07/php-script-to-compare-mysql-database-schemas/).
7 | 


--------------------------------------------------------------------------------
/config.php.dist:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * This file should contain the configuration of databases.
 5 |  *
 6 |  * $dbs_config is an array of database configurations. Each element of the
 7 |  * array should provide details for a database which will be selectable from
 8 |  * a list.
 9 |  *
10 |  * This is arguably more secure and convenient than submitting database
11 |  * details with an HTML form (and sending them over an unsecured channel).
12 |  *
13 |  * Refer to the 'Demo Configuration' below for reference.
14 |  */
15 | 
16 | $dbs_config = array(
17 | 	// array(
18 | 	// 	'name' => 'Demo Configuration',
19 | 	// 	'config' => array(
20 | 	// 		'host'		=> 'localhost',
21 | 	// 		'user'		=> 'db_user',
22 | 	// 		'password'	=> 'db_password',
23 | 	// 		'name'		=> 'db_name'
24 | 	// 	)
25 | 	// ),
26 | );
27 | 


--------------------------------------------------------------------------------
/cli.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | error_reporting(E_ALL);
 4 | 
 5 | require_once('DbDiff.php');
 6 | require('config.php');
 7 | 
 8 | $DbDiff = new DbDiff;
 9 | $schema1 = array();
10 | $schema2 = array();
11 | 
12 | if (isset($argv[1]) && isset($argv[2])) {
13 |     foreach ($dbs_config as $key => $config) {
14 |         if ($config['name'] == $argv[1]) {
15 |             $schema1 = $config;
16 |         }
17 |         if ($config['name'] == $argv[2]) {
18 |             $schema2 = $config;
19 |         }
20 |     }
21 |     if (count($schema1) < 1) {
22 |         echo "Database: $argv[1] not found\n";
23 |         exit;
24 |     }
25 |     if (count($schema2) < 1) {
26 |         echo "Database: $argv[2] not found\n";
27 |         exit;
28 |     }
29 | } else {
30 |     echo "Usage: \n";
31 |     echo "php " . $_SERVER['SCRIPT_NAME'] . " database1 database2\n";
32 |     echo "where database1 and database2 is the name of database in config.php \n";
33 |     exit;
34 | }
35 | 
36 | $result_schema1 = $DbDiff->export($schema1['config'], $schema1['name']);
37 | $result_schema2 = $DbDiff->export($schema2['config'], $schema2['name']);
38 | 
39 | $result = $DbDiff->compare($result_schema1, $result_schema2);
40 | foreach ($result as $table => $diffs) {
41 |     echo "\nTable \033[31m" . $table . "\033[0m\n";
42 |     foreach ($diffs as $diff) {
43 |         $diff = str_replace("<code>", "\033[31m", $diff);
44 |         $diff = str_replace("</code>", "\033[0m", $diff);
45 |         $diff = str_replace("<em>", "", $diff);
46 |         $diff = str_replace("</em>", "", $diff);
47 |         echo $diff . "\n";
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/style.css:
--------------------------------------------------------------------------------
  1 | 
  2 | body {
  3 |     background-color: #DDD;
  4 |     font: 75% "Lucida Grande", "Trebuchet MS", Verdana, sans-serif;
  5 | }
  6 | 
  7 | h1 {
  8 |     margin: 15px 0 0 0;
  9 | }
 10 | 
 11 | h1 a {
 12 |     color: #000;
 13 |     text-decoration: none;
 14 | }
 15 | 
 16 | h2 {
 17 |     margin: 0 0 10px 0;
 18 |     font-size: 10px;
 19 |     padding-bottom: 10px;
 20 |     border-bottom: 1px solid #444;
 21 | }
 22 | 
 23 | textarea {
 24 |     width: 100%;
 25 |     font-family: courier, fixed;
 26 | }
 27 | 
 28 | .info {
 29 |     background-color: #EEF;
 30 |     border-top: 1px solid #AAC;
 31 |     border-bottom: 1px solid #AAC;
 32 |     padding: 5px;
 33 | }
 34 | 
 35 | .error {
 36 |     background-color: #FEE;
 37 |     border-top: 1px solid #C66;
 38 |     border-bottom: 1px solid #C66;
 39 |     padding: 5px;
 40 | }
 41 | 
 42 | .clearer {
 43 |     clear: both;
 44 | }
 45 | 
 46 | form .field {
 47 |     margin-bottom: 6px;
 48 | }
 49 | 
 50 | form .field label {
 51 |     vertical-align: top;
 52 |     display: block;
 53 |     font-size: 90%;
 54 | }
 55 | 
 56 | form .submit {
 57 |     clear: both;
 58 | }
 59 | 
 60 | #canvas {
 61 |     background-color: #FFF;
 62 |     margin: 0 auto;
 63 |     border: 1px solid #AAA;
 64 |     width: 800px;
 65 |     padding: 10px 20px;
 66 | }
 67 | 
 68 | ul#db-list {
 69 |     list-style-type: square;
 70 |     margin-left: 15px;
 71 |     padding-left: 15px;
 72 | }
 73 | 
 74 | form#db-config {
 75 |     border-top: 1px solid #DDD;
 76 |     border-bottom: 1px solid #DDD;
 77 |     padding: 10px;
 78 |     background-color: #F5F5F5;
 79 | }
 80 | 
 81 | form#db-config .field, form#db-config .submit {
 82 |     float: left;
 83 | }
 84 | 
 85 | form#db-config .field input {
 86 |     width: 10em;
 87 |     margin-right: 0.5em;
 88 | }
 89 | 
 90 | form#compare .field {
 91 |     width: 49%;
 92 |     float: left;
 93 | }
 94 | 
 95 | form#compare .field:first-child {
 96 |     margin-right: 2%;
 97 | }
 98 | 
 99 | ul#differences {
100 |     margin: 10px 15px;
101 |     padding: 0 15px;
102 | }
103 | 
104 | ul#differences ul {
105 |     margin: 5px 0 10px 15px;
106 |     padding: 0 0 0 15px;
107 | }
108 | 
109 | #footer {
110 |     margin: 20px 0 0;
111 | }
112 | 
113 | #footer, #footer a {
114 |     color: #999;
115 | }
116 | 
117 | #footer p {
118 |     margin: 5px 0;
119 | }
120 | 


--------------------------------------------------------------------------------
/DbDiff.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /**
  4 |  * Compare the schemas of between databases.
  5 |  *
  6 |  * For two database schemas to be considered the same, they must have the same
  7 |  * tables, where each table has the same fields, and each field has the same
  8 |  * parameters.
  9 |  *
 10 |  * Field parameters that are compared are those that are given by the MySQL
 11 |  * 'SHOW COLUMNS' command. These are: the field's name, it's type, whether the
 12 |  * field can store null values, whether the column is indexed, the default
 13 |  * values and whether the field was created with the 'auto_increment' keyword.
 14 |  */
 15 | class DbDiff
 16 | {
 17 | 
 18 |     /**
 19 |      * Export the schema of the database into an array.
 20 |      *
 21 |      * @param string $config Config details for the database connection.
 22 |      * @param string $name Name or description of the database.
 23 |      * @return mixed|string An array structure of the exported schema, or an error string.
 24 |      */
 25 |     public static function export($config, $name)
 26 |     {
 27 |         $db = mysqli_connect($config['host'], $config['user'], $config['password']);
 28 | 
 29 |         if (!$db) {
 30 |             return null;
 31 |         }
 32 | 
 33 |         if (!mysqli_select_db($db, $config['name'])) {
 34 |             return null;
 35 |         }
 36 | 
 37 |         $result = mysqli_query($db, "SHOW TABLES");
 38 |         while ($row = mysqli_fetch_row($result)) {
 39 |             $tables[$row[0]] = array();
 40 |         }
 41 | 
 42 |         foreach ($tables as $table_name => $fields) {
 43 | 
 44 |             $result = mysqli_query($db, "SHOW COLUMNS FROM `" . $table_name . "`");
 45 |             while ($row = mysqli_fetch_assoc($result)) {
 46 |                 $tables[$table_name][$row['Field']] = $row;
 47 |             }
 48 |         }
 49 | 
 50 |         mysqli_close($db);
 51 | 
 52 |         $data = array(
 53 |             'name' => $name,
 54 |             'time' => time(),
 55 |             'tables' => $tables
 56 |         );
 57 | 
 58 |         return $data;
 59 |     }
 60 | 
 61 |     /**
 62 |      * Compare two schemas (as generated by the 'export' method.)
 63 |      *
 64 |      * @param string $schema1 The first database schema.
 65 |      * @param string $schema2 The second database schema.
 66 |      * @return array The results of the comparison.
 67 |      */
 68 |     public static function compare($schema1, $schema2)
 69 |     {
 70 |         $tables1 = array_keys($schema1['tables']);
 71 |         $tables2 = array_keys($schema2['tables']);
 72 | 
 73 |         $tables = array_unique(array_merge($tables1, $tables2));
 74 |         $results = array();
 75 | 
 76 |         foreach ($tables as $table_name) {
 77 | 
 78 |             // Check tables exist in both databases
 79 | 
 80 |             if (!isset($schema1['tables'][$table_name])) {
 81 | 
 82 |                 $results[$table_name][] = '<em>' . $schema1['name']
 83 |                         . '</em> is missing table: <code>' . $table_name
 84 |                         . '</code>.';
 85 | 
 86 |                 continue;
 87 |             }
 88 | 
 89 |             if (!isset($schema2['tables'][$table_name])) {
 90 | 
 91 |                 $results[$table_name][] = '<em>' . $schema2['name']
 92 |                         . '</em> is missing table: <code>' . $table_name
 93 |                         . '</code>.';
 94 | 
 95 |                 continue;
 96 |             }
 97 | 
 98 |             // Check fields exist in both tables
 99 | 
100 |             $fields = array_merge($schema1['tables'][$table_name], $schema2['tables'][$table_name]);
101 | 
102 |             foreach ($fields as $field_name => $field) {
103 | 
104 |                 if (!isset($schema1['tables'][$table_name][$field_name])) {
105 | 
106 |                     $results[$table_name][] = '<em>' . $schema1['name']
107 |                             . '</em> is missing field: <code>' . $field_name
108 |                             . '</code>';
109 | 
110 |                     continue;
111 |                 }
112 | 
113 |                 if (!isset($schema2['tables'][$table_name][$field_name])) {
114 | 
115 |                     $results[$table_name][] = '<em>' . $schema2['name']
116 |                             . '</em> is missing field: <code>' . $field_name
117 |                             . '</code>';
118 | 
119 |                     continue;
120 |                 }
121 | 
122 |                 // Check that the specific parameters of the fields match
123 | 
124 |                 $s1_params = $schema1['tables'][$table_name][$field_name];
125 |                 $s2_params = $schema2['tables'][$table_name][$field_name];
126 | 
127 |                 foreach ($s1_params as $name => $details) {
128 |                     if ($s1_params[$name] != $s2_params[$name]) {
129 |                         $results[$table_name][] = 'Field <code>' . $field_name
130 |                                 . '</code> differs between databases for parameter \''
131 |                                 . $name . '\'. <em>' . $schema1['name']
132 |                                 . '</em> has \'' . $s1_params[$name]
133 |                                 . '\' and <em>' . $schema2['name']
134 |                                 . '</em> has \'' . $s2_params[$name] . '\'.';
135 |                     }
136 |                 }
137 |             }
138 |         }
139 | 
140 |         return $results;
141 |     }
142 | 
143 | }
144 | 


--------------------------------------------------------------------------------
/index.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * This provides a user-interface for using the DbDiff class.
  4 |  */
  5 | error_reporting(E_ALL);
  6 | 
  7 | require_once('DbDiff.php');
  8 | require('config.php');
  9 | 
 10 | /**
 11 |  * Display options and instructions.
 12 |  *
 13 |  * @return void
 14 |  */
 15 | function show_options($dbs_config)
 16 | {
 17 |     echo '<h3>Step 1: Export database schemas</h3>';
 18 | 
 19 |     if (count($dbs_config) > 0) {
 20 | 
 21 |         echo '<p class="info">Select a database configuration from the list below, or select \'Enter details...\'</p>';
 22 | 
 23 |         echo '<ul id="db-list">';
 24 |         foreach ($dbs_config as $key => $db_config) {
 25 |             echo '<li><a href="?a=export_schema&db=' . $key . '">' . $db_config['name'] . '</a></li>';
 26 |         }
 27 |         echo '<li><em><a href="#" onclick="document.getElementById(\'db-config\').style.display=\'block\';return false;">Enter details...</a></em></li>';
 28 |         echo '</ul>';
 29 |     } else {
 30 | 
 31 |         echo '<p class="info">Enter connection details in the form below, or setup a database connection in the <code>config.php</code> file.</p>';
 32 |     }
 33 | 
 34 |     echo '<form action="?a=export_schema" method="post" id="db-config"' . (count($dbs_config) > 0 ? ' style="display:none;"' : '' ) . '>';
 35 |     echo '<div class="field"><label for="db-host">Host</label><input type="text" name="db-host" id="db-host" value="localhost" /></div>';
 36 |     echo '<div class="field"><label for="db-user">User</label><input type="text" name="db-user" id="db-user" /></div>';
 37 |     echo '<div class="field"><label for="db-password">Password</label><input type="password" name="db-password" id="db-password" /></div>';
 38 |     echo '<div class="field"><label for="db-name">Database</label><input type="text" name="db-name" id="db-name" /></div>';
 39 |     echo '<div class="submit"><input type="submit" value="Export" /></div><div class="clearer"></div>';
 40 |     echo '</form>';
 41 | 
 42 |     echo '<h3>Step 2: Compare schemas</h3>';
 43 | 
 44 |     echo '<p class="info">Once two database schemas have been exported, paste them here to be compared.</p>';
 45 | 
 46 |     echo '<form action="?a=compare" method="post" id="compare">';
 47 |     if (count($dbs_config) < 2) {
 48 |         echo '<div class="field"><label for="schema1">First schema</label><textarea name="schema1" id="schema1" cols="100" rows="5"></textarea></div>';
 49 |         echo '<div class="field"><label for="schema2">Second schema</label><textarea name="schema2" id="schema2" cols="100" rows="5"></textarea></div>';
 50 |     } else {
 51 |         echo '<div class=""><label for="schema1">First schema</label><select name="schema1">';
 52 |         foreach ($dbs_config as $key => $db_config) {
 53 |             echo '<option value=' . $key . '>' . $db_config['name'] . '</option>';
 54 |         }
 55 |         echo '</select></div>';
 56 |         echo '<div class=""><label for="schema2">Second schema</label><select name="schema2">';
 57 |         foreach ($dbs_config as $key => $db_config) {
 58 |             echo '<option value=' . $key . '>' . $db_config['name'] . '</option>';
 59 |         }
 60 |         echo '</select></div>';
 61 |     }
 62 | 
 63 |     echo '<div class="submit"><input type="submit" value="Compare" /></div>';
 64 |     echo '</form>';
 65 | }
 66 | 
 67 | /**
 68 |  * Convenience method for outputting errors.
 69 |  *
 70 |  * @return void
 71 |  * */
 72 | function echo_error($error)
 73 | {
 74 |     echo '<p class="error">', $error, '</p>';
 75 | }
 76 | 
 77 | /**
 78 |  * Export the schema from the database specified and echo the results.
 79 |  *
 80 |  * @param string $db The key of the config to be extracted from $dbs_config.
 81 |  * @return void
 82 |  */
 83 | function export_schema($config)
 84 | {
 85 |     $result = DbDiff::export($config['config'], $config['name']);
 86 | 
 87 |     if ($result == null) {
 88 |         echo_error('Couldn\'t connect to database: ' . mysql_error());
 89 |         return;
 90 |     }
 91 | 
 92 |     $serialized_schema = serialize($result);
 93 | 
 94 |     echo '<h3>Exported \'' . $config['name'] . '\'</h3>';
 95 |     echo '<p>Copy the following schema information and then proceed to <a href="?">step 2</a>.</p>';
 96 |     echo '<textarea cols="100" rows="20" onclick="this.focus();this.select();">';
 97 |     echo chunk_split($serialized_schema, 100);
 98 |     echo '</textarea>';
 99 | }
100 | 
101 | /**
102 |  * Strips new line characters (CR and LF) from a string.
103 |  *
104 |  * @param string $str The string to process.
105 |  * @return string The string without CRs or LFs.
106 |  */
107 | function strip_nl($str)
108 | {
109 |     return str_replace(array("\n", "\r"), '', $str);
110 | }
111 | 
112 | /**
113 |  * Returns an 's' character if the count is not 1.
114 |  *
115 |  * This is useful for adding plurals.
116 |  *
117 |  * @return string An 's' character or an empty string
118 |  * */
119 | function s($count)
120 | {
121 |     return $count != 1 ? 's' : '';
122 | }
123 | 
124 | /**
125 |  * Compare the two schemas and echo the results.
126 |  *
127 |  * @param string $schema1 The first schema (serialized).
128 |  * @param string $schema2 The second schema (serialized).
129 |  * @return void
130 |  */
131 | function do_compare($schema1, $schema2)
132 | {
133 |     if (empty($schema1) || empty($schema2)) {
134 |         echo_error('Both schemas must be given.');
135 |         return;
136 |     }
137 | 
138 |     $unserialized_schema1 = unserialize(strip_nl($schema1));
139 |     $unserialized_schema2 = unserialize(strip_nl($schema2));
140 | 
141 |     $results = DbDiff::compare($unserialized_schema1, $unserialized_schema2);
142 | 
143 |     if (count($results) > 0) {
144 | 
145 |         echo '<h3>Found differences in ' . count($results) . ' table' . s(count($results)) . ':</h3>';
146 | 
147 |         echo '<ul id="differences">';
148 |         foreach ($results as $table_name => $differences) {
149 | 
150 |             echo '<li><strong>' . $table_name . '</strong><ul>';
151 |             foreach ($differences as $difference) {
152 |                 echo '<li>' . $difference . '</li>';
153 |             }
154 |             echo '</ul></li>';
155 |         }
156 |         echo '</ul>';
157 |     } else {
158 |         echo '<p>No differences found.</p>';
159 |     }
160 | }
161 | ?>
162 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
163 | <html lang="en">
164 |     <head>
165 |         <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
166 |         <title>DbDiff</title>
167 |         <link rel="stylesheet" href="style.css" type="text/css" media="screen" />
168 |     </head>
169 |     <body>
170 |         <div id="canvas">
171 |             <h1><a href="?">DbDiff</a></h1>
172 |             <h2>Tool for comparing database schemas.</h2>
173 | 
174 |             <?php
175 |             $action = @$_GET['a'];
176 | 
177 |             switch ($action) {
178 | 
179 |                 case 'export_schema':
180 | 
181 |                     if (isset($_GET['db'])) {
182 | 
183 |                         $db = $_GET['db'];
184 | 
185 |                         if (!isset($dbs_config[$db])) {
186 |                             echo_error('No database configuration selected.');
187 |                             break;
188 |                         }
189 | 
190 |                         $config = $dbs_config[$db];
191 |                     } else {
192 | 
193 |                         if (!isset($_POST['db-host']) || !isset($_POST['db-user']) || !isset($_POST['db-password']) || !isset($_POST['db-name'])) {
194 |                             echo_error('No database configuration entered.');
195 |                             break;
196 |                         }
197 | 
198 |                         $config = array(
199 |                             'name' => $_POST['db-name'] . ' (' . $_POST['db-host'] . ')',
200 |                             'config' => array(
201 |                                 'host' => $_POST['db-host'],
202 |                                 'user' => $_POST['db-user'],
203 |                                 'password' => $_POST['db-password'],
204 |                                 'name' => $_POST['db-name']
205 |                             )
206 |                         );
207 |                     }
208 | 
209 |                     export_schema($config);
210 | 
211 |                     echo '<p><a href="?">&laquo; Back to main page</a></p>';
212 |                     break;
213 |                 case 'compare':
214 |                     if (count($dbs_config) < 2) {
215 |                         $schema1 = @$_POST['schema1'];
216 |                         $schema2 = @$_POST['schema2'];
217 | 
218 |                         if (get_magic_quotes_gpc()) { // sigh...
219 |                             $schema1 = stripslashes($schema1);
220 |                             $schema2 = stripslashes($schema2);
221 |                         }
222 |                     } else {
223 |                         $schema1 = $dbs_config[@$_POST['schema1']];
224 |                         $schema2 = $dbs_config[@$_POST['schema2']];
225 | 
226 |                         $schema1 = serialize(DbDiff::export($schema1['config'], $schema1['name']));
227 |                         $schema2 = serialize(DbDiff::export($schema2['config'], $schema2['name']));
228 |                     }
229 | 
230 |                     do_compare($schema1, $schema2);
231 | 
232 |                     echo '<p><a href="?">&laquo; Back to main page</a></p>';
233 |                     break;
234 |                 default:
235 |                     show_options($dbs_config);
236 |             }
237 |             ?>
238 |             <div id="footer">
239 |                 <p>More information on this tool is available from the corresponding <a href="http://joefreeman.co.uk/blog/2009/07/php-script-to-compare-mysql-database-schemas/">blog post</a>.</p>
240 |             </div>
241 |         </div>
242 |     </body>
243 | </html>


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "{}"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright {yyyy} {name of copyright owner}
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------