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 $argv = $_SERVER['argv'];
71 $opts = explode(',', 'table==,where==,dump-dir==');
72 require_once 'Console/Getopt.php';
73 $go = Console_Getopt::getopt2($argv, '', $opts );
78 foreach($go[0] as $ar) {
79 $args[substr($ar[0],2)] = $ar[1];
82 foreach($opts as $req) {
83 if (empty($args[substr($req,0, -2)])) {
84 $errs[] = "--".substr($req,0, -2) . ' is required';
88 die(print_R($errs,true));
93 $this->discoverChildren($this->args['table'], $this->args['where'], true);
94 print_R($this->deletes);exit;
96 $this->discover($this->args['table'], $this->args['where'], true);
97 print_r($this->dumps);
101 if (!file_exists($args['dump-dir'])) {
102 mkdir($args['dump-dir'], 0777, true);
105 $this->generateInsert();
106 $this->generateDelete();
107 $this->generateShell();
109 echo "GENERATED FILES:";
117 var $deletes = array(); // TABLE => [key] => TRUE|FALSE
118 var $dumps = array(); // TABLE => [key] => TRUE|FALSE - if it's been scanned..
119 var $dscan = array(); // TABLE:COL => [value => TRUE|FALSE] - if its been scanned..
122 * a) what depends on it (eg. child elements) - which will be deleted.
123 * b) what it depends on it (eg. parent elements) - which will be dumped..
126 function discover($table, $where, $is_delete = false )
129 if (!isset($this->dumps[$table])) {
130 $this->dumps[$table] = array();
132 if ($is_delete && !isset($this->deletes[$table])) {
133 $this->deletes[$table] = array();
135 //DB_DataObject::debugLevel(1);
136 $x = DB_DataObject::factory($table);
137 if (PEAR::isError($x)) {
138 if (isset($this->dumps[$table])) {
139 unset($this->dumps[$table]); // links to non-existant tables..
146 if (is_array( $where)) {
147 $x->whereAddIn($keys[0] , $where, 'int');
150 $x->whereAdd($where);
153 // a) id's of elements in this table
154 // b) columns which point to other tables..
155 $links = $x->links();
156 $cols = array_keys($links);
158 array_push($cols, $keys[0]);
162 $x->selectAdd('`'. implode('`,`', $cols) . '`');
164 //DB_DataObject::debugLevel(0);
165 while ($x->fetch()) {
166 foreach($cols as $k) {
167 if (empty($x->$k)) { // skip blanks.
170 if (isset($links[$k])) {
172 $kv = explode(':', $links[$k]);
173 if (!isset($this->dumps[$kv[0]])) {
174 $this->dumps[$kv[0]] = array();
176 if (!isset($this->dumps[$kv[0]][$x->$k])) {
177 $this->dumps[$kv[0]][$x->$k] = 0; // not checked yet..
181 // assume it's the key..
182 if (empty($this->dumps[$table][$x->$k])) {
183 $this->dumps[$table][$x->$k] = 1; // we have checked this one...
185 //if ($is_delete && !isset($this->deletes[$table][$x->$k])) {
187 // $this->deletes[$table][$x->$k] = 0 ; // not checked yet..
194 // flag as checked if we where given an array.. - as some links might have been broken.
195 if (is_array($where)) {
196 foreach($where as $k) {
197 $this->dumps[$table][$k] = 1;
202 // itterate through dumps to find what needs discovering
203 foreach($this->dumps as $k=>$v) {
205 foreach($v as $id => $fetched) {
211 $this->discover($k, $ar,false);
223 function discoverChildren($table, $where, $col=false )
225 global $_DB_DATAOBJECT;
226 $do = DB_DataObject::factory($table);
227 if (PEAR::isError($do)) {
228 if (isset($this->dumps[$table])) {
229 unset($this->dumps[$table]); // links to non-existant tables..
233 if (!isset($this->dumps[$table])) {
234 $this->dumps[$table] = array();
236 if (!isset($this->deletes[$table])) {
237 $this->deletes[$table] = array();
243 if (is_array( $where)) {
244 $do->whereAddIn($col ? $col : $keys[0] , $where, 'int');
247 $do->whereAdd($where);
250 static $children = array();
252 if (!isset($children[$table])) {
254 // force load of linsk
256 foreach($_DB_DATAOBJECT['LINKS'][$do->database()] as $tbl => $links) {
257 // hack.. - we should get rid of this hack..
258 if ($tbl == 'database__render') {
261 //if ($tbl == $tn) { // skip same table
264 foreach ($links as $tk => $kv) {
267 list($k,$v) = explode(':', $kv);
271 $add = implode(':', array($tbl, $tk));
272 //echo "ADD $tbl $tk=>$kv : $add\n";
273 $children[$table][$add] = true;
279 if (empty($children[$table])) {
286 $do->selectAdd($key);
288 while ($do->fetch()) {
289 $this->dumps[$table][$do->id] = 0;
290 if (!isset($this->deletes[$table][$do->key])) {
291 $this->deletes[$table][$do->key] = 0;
294 foreach($children[$table] as $kv=>$t) {
295 if (!isset($this->dscan[$kv])) {
296 $this->dscan[$kv] = array();
298 if (!isset($this->dscan[$kv][$do->$key])) {
299 $this->dscan[$kv][$do->$key]= 0; // unscanned.
305 // now iterate throught dependants. and scan them.
308 foreach($this->dscan as $kv => $ids) {
310 foreach($ids as $id => $checked) {
312 $this->dscan[$kv][$id] = 1; // flag it as checked.
321 list($k, $v) = explode(':', $kv);
322 $this->discoverChildren($k, $ar, $v);
331 function oldStuff() {
335 $target = $args['dump-dir'] .'/'. date('Y-m-d').'.sql';
337 $this->fh = fopen($target,'w');
339 //DB_DataObject::debugLevel(1);
340 // since we are runnign in cli mode... we will be a bit wild and free with verification
341 $x = DB_DataObject::factory($args['table']);
342 $x->{$args['col']} = $args['val'];
346 while ($x->fetch()) {
348 fwrite($this->fh, $this->toInsert($x));
349 $this->dumpChildren($x);
354 foreach($this->deps as $s=>$status) {
355 if (isset($this->dumped[$s])) {
358 list($tbl, $key, $val) = explode(':', $s);
359 $dd = DB_DataObject::factory($tbl);
360 if ($dd->get($key,$val)) {
361 fwrite($this->fh, $this->toInsert($dd));
368 function generateDelete() {
369 $target = $this->args['dump-dir'] .'/'. date('Y-m-d').'.delete.sql';
370 $this->out[] = $target;
371 $fh = fopen($target, 'w');
372 foreach($this->childscanned as $s=>$v) {
373 list($tbl, $key, $val) = explode(':', $s);
374 fwrite($fh, "DELETE FROM $tbl WHERE $key = $val;\n"); // we assume id's and nice column names...
379 function generateShell() {
382 $target = $this->args['dump-dir'] .'/'. date('Y-m-d').'.copy.sh';
383 $this->out[] = $target;
384 $fh = fopen($target, 'w');
386 $target = $this->args['dump-dir'] .'/'. date('Y-m-d').'.delete.sh';
387 $this->out[] = $target;
388 $fh2 = fopen($target, 'w');
390 $target = $this->args['dump-dir'] .'/'. date('Y-m-d').'.restore.sh';
391 $this->out[] = $target;
392 $fh3 = fopen($target, 'w');
395 foreach($this->childfiles as $s=>$v) {
396 fwrite($fh,"mkdir -p " . escapeshellarg(dirname($args['dump-dir'] .'/'.$v[1])) ."\n" );
397 fwrite($fh,"cp " . escapeshellarg($v[0].'/'.$v[1]) . ' ' . escapeshellarg($args['dump-dir'] .'/'.$v[1]) ."\n" );
399 fwrite($fh3,"mkdir -p " . escapeshellarg(dirname($v[0].'/'.$v[1])) ."\n" );
400 fwrite($fh3,"cp " . escapeshellarg($args['dump-dir'] .'/'.$v[1]) . ' ' . escapeshellarg($v[0].'/'.$v[1]) . "\n" );
402 fwrite($fh2,"rm " . escapeshellarg($v[0].'/'.$v[1]) ."\n" );
405 fclose($fh3); // restore does not need to bother with thumbnails.
409 foreach($this->childthumbs as $s=>$v) {
411 fwrite($fh2,"rm " . escapeshellarg($vv). "\n");
419 var $children = array(); // map of search->checked
420 var $childscanned = array();
421 var $childfiles = array();
422 var $childthumbs = array();
423 function dumpChildren($do)
425 $kcol = array_shift($do->keys());
426 $kid = $do->tableName() . ':' . $kcol . ':' . $do->{$kcol};
427 if (isset($this->childscanned[$kid])) {
430 $this->childscanned[$kid] = true;
432 if (method_exists($do,'archivePaths')) {
433 $ct = $do->archivePaths();
435 $this->childfiles[$kid] = $ct;
438 if (method_exists($do,'listThumbs')) {
439 $ct = $do->listThumbs();
441 $this->childthumbs[$kid] = $ct;
445 global $_DB_DATAOBJECT;
446 $do->links();; //force load
447 $tn = $do->tableName();
450 foreach($_DB_DATAOBJECT['LINKS'][$do->database()] as $tbl => $links) {
451 // hack.. - we should get rid of this hack..
452 if ($tbl == 'database__render') {
455 //if ($tbl == $tn) { // skip same table
458 foreach ($links as $tk => $kv) {
461 list($k,$v) = explode(':', $kv);
465 $add = implode(':', array($tbl, $tk, $do->$v));
466 //echo "ADD $tbl $tk=>$kv : $add\n";
467 $this->children[$add] = 0;
472 // print_r($this->children);exit;
473 $ch = $this->children ;
476 foreach($ch as $s=>$status) {
477 if ($this->children[$s]) {
480 // flag it as being done, so we do not recurse..
481 $this->children[$s] = 1;
483 list($tbl, $key, $val) = explode(':', $s);
484 $dd = DB_DataObject::factory($tbl);
488 while ($dd->fetch()) {
489 $todo [] = clone($dd);
490 // if we have dumped this already.. ignore it..
496 foreach($todo as $dd) {
497 fwrite($this->fh, $this->toInsert($dd));
498 $this->dumpChildren($dd);
506 var $dumped = array();
508 * toInsert - does not handle NULLS...
510 function toInsert($do)
512 $kcol = array_shift($do->keys());
513 $kid = $do->tableName() . ':' . $kcol . ':' . $do->{$kcol};
514 if (isset($this->dumped[$kid])) {
517 //echo "DUMP: $kid\n";
518 $this->dumped[$kid] = true;
520 // for auto_inc column we need to use a 'set argument'...
521 $items = $do->table();
523 $quoteIdentifiers = !empty($_DB_DATAOBJECT['CONFIG']['quote_identifiers']);
529 $deplinks = $do->links();
531 foreach( $items as $k=>$v)
538 $leftq .= ($quoteIdentifiers ? ($DB->quoteIdentifier($k) . ' ') : "$k ");
540 // only handles numeric links..
541 if (is_numeric($do->$k) && $do->$k && $deplinks && !empty($deplinks[$k])) {
542 // die("got deplink" . $deplinks[$k]);
543 $l = explode(':', $deplinks[$k]);
544 $add = $deplinks[$k].':' . $do->$k;
546 $this->deps[$add] = 0;
551 if ($v & DB_DATAOBJECT_STR) {
552 $rightq .= $do->_quote((string) (
553 ($v & DB_DATAOBJECT_BOOL) ?
554 // this is thanks to the braindead idea of postgres to
555 // use t/f for boolean.
556 (($do->$k === 'f') ? 0 : (int)(bool) $do->$k) :
561 if (is_numeric($do->$k)) {
562 $rightq .=" {$do->$k} ";
565 $rightq .= ' ' . intval($do->$k) . ' ';
567 $table = ($quoteIdentifiers ? $DB->quoteIdentifier($do->__table) : $do->__table);
568 return "INSERT INTO {$table} ($leftq) VALUES ($rightq);\n";