5 * This should allow you to dump a series of data, so it could be restored later...
6 * The format will be an SQL file...
9 * php index.php Admin/Dump --table=Project --where="id=123"
10 * --dump-dir=/directory_to_put_sql+shell files
12 * outputs list of generated files.
15 * {DATE}.sql - the recreate sql including all dependancies, run with mysql DB -f < ....
16 * {DATE}.restore.sh - shell script to recreate files that where removed (excluding thumgs)
19 * {DATE}.copy.sh - shell script that backs up all the related files.
22 * {DATE}.delete.sql - the delete data sql.
23 * {DATE}.delete.sh - shell script to delete the files related to these records
26 * Basically it has to output all the records and their dependants. (parent and children)
28 * Then when deleting it deletes record + children..
31 * Each ouput is simple insert statement..
34 * TODO - handle Images table (or similar) where we use tablename=XXXX, tid=.... etc..
39 * DataObjects->archivePaths() - returns array ( sourcedirectory, remainder of path to dependant file )
40 * DataObjects->listThumbs() - returns array ( list of full path to thumbnail urls. )
49 require_once 'Pman.php';
51 class Pman_Admin_Dump extends Pman {
56 if (!HTML_FlexyFramework::get()->cli) {
57 die("Access only permitted from cli");
62 var $deps = array(); // list of dependants
63 var $out = array(); // list of created sql/shell scripts.
67 ini_set('memory_limit', '256M'); // we need alot of memory
70 $argv = $_SERVER['argv'];
74 $opts = explode(',', 'table==,where==,dump-dir==,debug=');
75 require_once 'Console/Getopt.php';
76 $go = Console_Getopt::getopt2($argv, '', $opts );
81 foreach($go[0] as $ar) {
82 $args[substr($ar[0],2)] = $ar[1];
85 foreach($opts as $req) {
86 if (substr($req,-2, 2) != '==') { // skip optional arguments
89 if (empty($args[substr($req,0, -2)])) {
90 $errs[] = "--".substr($req,0, -2) . ' is required';
94 die(print_R($errs,true));
96 if (!empty($args['debug'])) {
97 DB_DataObject::debugLevel($args['debug']);
100 $this->out = array();
101 $this->discoverChildren($this->args['table'], $this->args['where'], true);
102 //print_R($this->deletes);
103 //print_r($this->dumps);
106 $this->discover($this->args['table'], $this->args['where'], true);
109 if (!file_exists($args['dump-dir'])) {
110 mkdir($args['dump-dir'], 0777, true);
113 $this->generateInsert();
114 $this->generateDelete();
115 $this->generateShell();
118 foreach($this->deletes as $tbl => $ar) {
119 if (empty($ar)) { continue; }
120 echo " " .$tbl . ' -> ' . count(array_keys($ar)) . " Records\n";
123 foreach($this->dumps as $tbl => $ar) {
124 if (empty($ar)) { continue; }
125 echo " " .$tbl . ' -> ' . count(array_keys($ar)) . " Records\n";
128 echo " Total : " . $this->filetotal . " files using " . floor($this->filesize/1000000) . "Mb\n";
130 echo "GENERATED FILES:\n";
132 echo " ". implode("\n ", $this->out). "\n";
141 var $deletes = array(); // TABLE => [key] => TRUE|FALSE
142 var $dumps = array(); // TABLE => [key] => TRUE|FALSE - if it's been scanned..
143 var $dscan = array(); // TABLE:COL => [value => TRUE|FALSE] - if its been scanned..
144 var $childfiles = array(); // array of [ 'sourcedirectory' , 'subdirectory(s) and filename' ]
145 var $childthumbs = array(); // array of [ 'filename', 'filename' ,......]
146 var $filesize = 0; // size of files to be saved. (not total deletd..)
147 var $filetotal = 0; // number of distinct files to be saved (not total deleted)
150 * a) what depends on it (eg. child elements) - which will be deleted.
151 * b) what it depends on it (eg. parent elements) - which will be dumped..
154 function discover($table, $where, $is_delete = false )
157 if (!isset($this->dumps[$table])) {
158 $this->dumps[$table] = array();
160 if ($is_delete && !isset($this->deletes[$table])) {
161 $this->deletes[$table] = array();
163 //DB_DataObject::debugLevel(1);
164 $x = DB_DataObject::factory($table);
165 if (PEAR::isError($x)) {
166 if (isset($this->dumps[$table])) {
167 unset($this->dumps[$table]); // links to non-existant tables..
174 if (is_array( $where)) {
175 $x->whereAddIn($keys[0] , $where, 'int');
178 $x->whereAdd($where);
181 // a) id's of elements in this table
182 // b) columns which point to other tables..
183 $links = $x->links();
184 $cols = array_keys($links);
186 array_push($cols, $keys[0]);
190 $x->selectAdd('`'. implode('`,`', $cols) . '`');
192 //DB_DataObject::debugLevel(0);
193 while ($x->fetch()) {
194 foreach($cols as $k) {
195 if (empty($x->$k)) { // skip blanks.
198 if (isset($links[$k])) {
200 $kv = explode(':', $links[$k]);
201 if (!isset($this->dumps[$kv[0]])) {
202 $this->dumps[$kv[0]] = array();
204 if (!isset($this->dumps[$kv[0]][$x->$k])) {
205 $this->dumps[$kv[0]][$x->$k] = 0; // not checked yet..
209 // assume it's the key..
210 if (empty($this->dumps[$table][$x->$k])) {
211 $this->dumps[$table][$x->$k] = 1; // we have checked this one...
213 //if ($is_delete && !isset($this->deletes[$table][$x->$k])) {
215 // $this->deletes[$table][$x->$k] = 0 ; // not checked yet..
223 // flag as checked if we where given an array.. - as some links might have been broken.
224 if (is_array($where)) {
225 foreach($where as $k) {
226 $this->dumps[$table][$k] = 1;
231 // itterate through dumps to find what needs discovering
232 foreach($this->dumps as $k=>$v) {
234 foreach($v as $id => $fetched) {
240 $this->discover($k, $ar,false);
252 function discoverChildren($table, $where, $col=false )
254 echo "discoverChildren:$table:$col:". (is_array($where) ? (count($where) . " children" ): $where ). "\n";
255 global $_DB_DATAOBJECT;
256 $do = DB_DataObject::factory($table);
257 if (PEAR::isError($do)) {
258 if (isset($this->dumps[$table])) {
259 unset($this->dumps[$table]); // links to non-existant tables..
261 echo "SKIPPING invalid table $table\n";
264 if (!isset($this->dumps[$table])) {
265 $this->dumps[$table] = array();
267 if (!isset($this->deletes[$table])) {
268 $this->deletes[$table] = array();
274 if (is_array( $where)) {
275 $do->whereAddIn($col ? $col : $keys[0] , $where, 'int');
278 $do->whereAdd($where);
281 static $children = array();
283 if (!isset($children[$table])) {
284 $children[$table] = array();
285 // force load of linsk
287 foreach($_DB_DATAOBJECT['LINKS'][$do->database()] as $tbl => $links) {
288 // hack.. - we should get rid of this hack..
289 if ($tbl == 'database__render') {
292 //if ($tbl == $tn) { // skip same table
295 foreach ($links as $tk => $kv) {
298 list($k,$v) = explode(':', $kv);
302 $add = implode(':', array($tbl, $tk));
303 //echo "ADD $tbl $tk=>$kv : $add\n";
304 $children[$table][$add] = true;
314 $do->selectAdd($key);
315 echo "GOT ". $do->find() ." results\n";
316 //DB_DataObject::debugLevel(0);
317 while ($do->fetch()) {
318 $this->dumps[$table][$do->$key] = 0;
319 if (!isset($this->deletes[$table][$do->$key])) {
320 $this->deletes[$table][$do->$key] = 0;
323 foreach($children[$table] as $kv=>$t) {
324 if (!isset($this->dscan[$kv])) {
325 $this->dscan[$kv] = array();
327 if (!isset($this->dscan[$kv][$do->$key])) {
328 $this->dscan[$kv][$do->$key]= 0; // unscanned.
334 // now iterate throught dependants. and scan them.
337 foreach($this->dscan as $kv => $ids) {
339 foreach($ids as $id => $checked) {
341 $this->dscan[$kv][$id] = 1; // flag it as checked.
350 list($k, $v) = explode(':', $kv);
351 $this->discoverChildren($k, $ar, $v);
360 function generateDelete() {
361 $target = $this->args['dump-dir'] .'/'. date('Y-m-d').'.delete.sql';
362 $this->out[] = $target;
363 $fh = fopen($target, 'w');
367 foreach($this->deletes as $tbl=>$ar) {
369 $do = DB_DataObject::factory($tbl);
370 $tbl = $do->tableName();
373 $do->whereAddIn($keys[0] , array_keys($ar), 'int');
375 $archivePaths = method_exists($do,'archivePaths');
376 $listThumbs = method_exists($do,'listThumbs');
377 while ($do->fetch()) {
380 $ct = $do->archivePaths();
382 $this->childfiles[] = $ct;
386 $ct = $do->listThumbs();
388 $this->childthumbs[] = $ct;
393 fwrite($fh, "DELETE FROM `$tbl` WHERE `$key` = $id;\n"); // we assume id's and nice column names...
399 function generateShell() {
401 if (empty($this->childfiles) && empty($this->childthumbs)) {
404 $target = $this->args['dump-dir'] .'/'. date('Y-m-d').'.copy.sh';
405 $this->out[] = $target;
406 $fh = fopen($target, 'w');
408 $target = $this->args['dump-dir'] .'/'. date('Y-m-d').'.delete.sh';
409 $this->out[] = $target;
410 $fh2 = fopen($target, 'w');
412 $target = $this->args['dump-dir'] .'/'. date('Y-m-d').'.restore.sh';
413 $this->out[] = $target;
414 $fh3 = fopen($target, 'w');
419 foreach($this->childfiles as $v) {
421 if (isset($done[$v[1]])) {
427 $this->filesize += filesize($v[0].'/'.$v[1]);
429 $fdir = dirname($this->args['dump-dir'] .'/'.$v[1]);
430 if (!isset($donedir[$fdir])) {
431 fwrite($fh,"mkdir -p " . escapeshellarg(dirname($this->args['dump-dir'] .'/'.$v[1])) ."\n" );
433 fwrite($fh,"cp " . escapeshellarg($v[0].'/'.$v[1]) . ' ' . escapeshellarg($this->args['dump-dir'] .'/'.$v[1]) ."\n" );
434 if (!isset($donedir[$fdir])) {
435 fwrite($fh3,"mkdir -p " . escapeshellarg(dirname($v[0].'/'.$v[1])) ."\n" );
437 $donedir[$fdir] = true;
439 fwrite($fh3,"cp " . escapeshellarg($this->args['dump-dir'] .'/'.$v[1]) . ' ' . escapeshellarg($v[0].'/'.$v[1]) . "\n" );
440 fwrite($fh2,"rm " . escapeshellarg($v[0].'/'.$v[1]) ."\n" );
443 fclose($fh3); // restore does not need to bother with thumbnails.
447 foreach($this->childthumbs as $v) {
449 fwrite($fh2,"rm " . escapeshellarg($vv). "\n");
455 function generateInsert()
457 $target = $this->args['dump-dir'] .'/'. date('Y-m-d').'.sql';
458 $this->out[] = $target;
459 $fh = fopen($target,'w');
463 foreach($this->dumps as $tbl => $ar) {
467 $do = DB_DataObject::factory($tbl);
471 $do->whereAddIn($keys[0] , array_keys($ar), 'int');
473 while ($do->fetch()) {
474 fwrite($fh,$this->toInsert($do));
487 * toInsert - does not handle NULLS...
489 function toInsert($do)
491 $kcol = array_shift($do->keys());
493 // for auto_inc column we need to use a 'set argument'...
494 $items = $do->table();
501 $table = $do->tableName();
504 foreach( $items as $k=>$v)
511 $leftq .= '`' . $k . '`';
516 if ($v & DB_DATAOBJECT_STR) {
517 $rightq .= $do->_quote((string) (
518 ($v & DB_DATAOBJECT_BOOL) ?
519 // this is thanks to the braindead idea of postgres to
520 // use t/f for boolean.
521 (($do->$k === 'f') ? 0 : (int)(bool) $do->$k) :
526 if (is_numeric($do->$k)) {
527 $rightq .=" {$do->$k} ";
530 $rightq .= ' ' . intval($do->$k) . ' ';
533 return "INSERT INTO `{$table}` ($leftq) VALUES ($rightq);\n";