scripts/dumpschema.php

   1 #!/usr/bin/env php
   2 <?php
   3 /*
   4  * StatusNet - a distributed open-source microblogging tool
   5  * Copyright (C) 2008, 2009, StatusNet, Inc.
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
  22
  23 $helptext = <<<END_OF_CHECKSCHEMA_HELP
  24 Attempt to pull a schema definition for a given table.
  25
  26 END_OF_CHECKSCHEMA_HELP;
  27
  28 $longoptions = array('diff', 'all', 'build');
  29 require_once INSTALLDIR.'/scripts/commandline.inc';
  30
  31 function indentOptions($indent)
  32 {
  33     $cutoff = 3;
  34     if ($indent < $cutoff) {
  35         $space = $indent ? str_repeat(' ', $indent * 4) : '';
  36         $sep = ",";
  37         $lf = "\n";
  38         $endspace = "$lf" . ($indent ? str_repeat(' ', ($indent - 1) * 4) : '');
  39     } else {
  40         $space = '';
  41         $sep = ", ";
  42         $lf = '';
  43         $endspace = '';
  44     }
  45     if ($indent - 1 < $cutoff) {
  46     }
  47     return array($space, $sep, $lf, $endspace);
  48 }
  49
  50 function prettyDumpArray($arr, $key=null, $indent=0)
  51 {
  52     // hack
  53     if ($key == 'primary key') {
  54         $subIndent = $indent + 2;
  55     } else {
  56         $subIndent = $indent + 1;
  57     }
  58
  59     list($space, $sep, $lf, $endspace) = indentOptions($indent);
  60     list($inspace, $insep, $inlf, $inendspace) = indentOptions($subIndent);
  61
  62     print "{$space}";
  63     if (!is_numeric($key)) {
  64         print "'$key' => ";
  65     }
  66     if (is_array($arr)) {
  67         print "array({$inlf}";
  68         $n = 0;
  69         foreach ($arr as $key => $row) {
  70             $n++;
  71             prettyDumpArray($row, $key, $subIndent);
  72             if ($n < count($arr)) {
  73                 print "$insep$inlf";
  74             }
  75         }
  76         // hack!
  77         print "{$inendspace})";
  78     } else {
  79         print var_export($arr, true);
  80     }
  81 }
  82
  83 function getCoreSchema($tableName)
  84 {
  85     $schema = array();
  86     include INSTALLDIR . '/db/core.php';
  87     return $schema[$tableName];
  88 }
  89
  90 function getCoreTables()
  91 {
  92     $schema = array();
  93     include INSTALLDIR . '/db/core.php';
  94     return array_keys($schema);
  95 }
  96
  97 function dumpTable($tableName, $live)
  98 {
  99     if ($live) {
 100         $schema = Schema::get();
 101         $def = $schema->getTableDef($tableName);
 102     } else {
 103         // hack
 104         $def = getCoreSchema($tableName);
 105     }
 106     prettyDumpArray($def, $tableName);
 107 }
 108
 109 function dumpBuildTable($tableName)
 110 {
 111     echo "-- \n";
 112     echo "-- $tableName\n";
 113     echo "-- \n";
 114
 115     $schema = Schema::get();
 116     $def = getCoreSchema($tableName);
 117     $sql = $schema->buildCreateTable($tableName, $def);
 118     $sql[] = '';
 119
 120     echo implode(";\n", $sql);
 121     echo "\n";
 122 }
 123
 124 function showDiff($a, $b)
 125 {
 126     $fnameA = tempnam(sys_get_temp_dir(), 'defined-diff-a');
 127     file_put_contents($fnameA, $a);
 128
 129     $fnameB = tempnam(sys_get_temp_dir(), 'detected-diff-b');
 130     file_put_contents($fnameB, $b);
 131
 132     $cmd = sprintf('diff -U 100 %s %s',
 133             escapeshellarg($fnameA),
 134             escapeshellarg($fnameB));
 135     passthru($cmd);
 136
 137     unlink($fnameA);
 138     unlink($fnameB);
 139 }
 140
 141 if (have_option('all')) {
 142     $args = getCoreTables();
 143 }
 144
 145 if (count($args)) {
 146     foreach ($args as $tableName) {
 147         if (have_option('diff')) {
 148             ob_start();
 149             dumpTable($tableName, false);
 150             $defined = ob_get_clean();
 151
 152             ob_start();
 153             dumpTable($tableName, true);
 154             $detected = ob_get_clean();
 155
 156             showDiff($defined, $detected);
 157         } else if (have_option('build')) {
 158             dumpBuildTable($tableName);
 159         } else {
 160             dumpTable($tableName, true);
 161         }
 162     }
 163 } else {
 164     show_help($helptext);
 165 }