git.roojs.org Git - Pman.Core/blob - RooPostTrait.php

   1 <?php
   2
   3 trait Pman_Core_RooPostTrait {
   4
   5     /**
   6      * POST method   Roo/TABLENAME
   7      * -- creates, updates, or deletes data.
   8      *
   9      * INSERT
  10      *    if the primary key is empty, this happens
  11      *    will automatically set these to current date and authUser->id
  12      *        created, created_by, created_dt
  13      *        updated, update_by, updated_dt
  14      *        modified, modified_by, modified_dt
  15      *
  16      *   will return a GET request SINGLE SELECT (and accepts same)
  17      *
  18      * DELETE
  19      *    _delete=1,2,3     delete a set of data.
  20      * UPDATE
  21      *    if the primary key value is set, then update occurs.
  22      *    will automatically set these to current date and authUser->id
  23      *        updated, update_by, updated_dt
  24      *        modified, modified_by, modified_dt
  25      *
  26      *
  27      * Params:
  28      *   _delete=1,2,3   causes a delete to occur.
  29      *   _ids=1,2,3,4    causes update to occur on all primary ids.
  30      *
  31      *  RETURNS
  32      *     = same as single SELECT GET request..
  33      *
  34      *
  35      *
  36      * DEBUGGING
  37      *   _debug=1    forces debug
  38      *   _get=1 - causes a get request to occur when doing a POST..
  39      *
  40      *
  41      * CALLS
  42      *   these methods on dataobjects if they exist
  43      *
  44      *   checkPerm('E' / 'D' , $authuser)
  45      *                      - can we list the stuff
  46      *                      - return false to disallow...
  47
  48      *   toRooSingleArray($authUser, $request) : array
  49      *                       - called on single fetch only, add or maniuplate returned array data.
  50      *   toRooArray($request) : array
  51      *                      - Called if toSingleArray does not exist.
  52      *                      - if you need to return different data than toArray..
  53      *
  54      *   toEventString()
  55      *                  (for logging - this is generically prefixed to all database operations.)
  56      *
  57      *
  58      *   onUpload($roo)
  59      *                  called when $_FILES is not empty
  60      *
  61      *
  62      *   setFromRoo($ar, $roo)
  63      *                      - alternative to setFrom() which is called if this method does not exist
  64      *                      - values from post (deal with dates etc.) - return true|error string.
  65      *                      - call $roo->jerr() on failure...
  66      *
  67      * CALLS BEFORE change occurs:
  68      *
  69      *      beforeDelete($dependants_array, $roo, $request)
  70      *                      Argument is an array of un-find/fetched dependant items.
  71      *                      - jerr() will stop insert.. (Prefered)
  72      *                      - return false for fail and set DO->err;
  73      *
  74      *      beforeUpdate($old, $request,$roo)
  75      *                      - after update - jerr() will stop insert..
  76      *      beforeInsert($request,$roo)
  77      *                      - before insert - jerr() will stop insert..
  78      *
  79      *
  80      * CALLS AFTER change occured
  81      *
  82      *      onUpdate($old, $request,$roo)
  83      *               - after update // return value ignored
  84      *
  85      *      onInsert($request,$roo)
  86      *                  - after insert
  87      *
  88      *      onDelete($request, $roo) - after delete
  89      *
  90      */
  91
  92     function post($tab) // update / insert (?? delete??)
  93     {
  94         PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
  95
  96         $this->checkDebug();
  97
  98         if (!empty($_REQUEST['_get'])) {
  99             return $this->get($tab);
 100         }
 101
 102         $this->init();
 103
 104         $x = $this->dataObject($tab);
 105
 106         $this->transObj = clone($x);
 107
 108         $this->transObj->query('BEGIN');
 109         // find the key and use that to get the thing..
 110         $keys = $x->keys();
 111         if (empty($keys) ) {
 112             $this->jerr('no key');
 113         }
 114
 115         $this->key = $keys[0];
 116
 117           // delete should be here...
 118         if (isset($_REQUEST['_delete'])) {
 119             // do we really delete stuff!?!?!?
 120             return $this->delete($x,$_REQUEST);
 121         }
 122
 123         $old = false;
 124
 125         // not sure if this is a good idea here...
 126
 127         if (!empty($_REQUEST['_ids'])) {
 128             $ids = explode(',',$_REQUEST['_ids']);
 129             $x->whereAddIn($this->key, $ids, 'int');
 130             $ar = $x->fetchAll();
 131
 132             foreach($ar as $x) {
 133                 $this->update($x, $_REQUEST);
 134
 135             }
 136             // all done..
 137             $this->jok("UPDATED");
 138
 139
 140         }
 141
 142         if (!empty($_REQUEST[$this->key])) {
 143             // it's a create..
 144             if (!$x->get($this->key, $_REQUEST[$this->key]))  {
 145                 $this->jerr("Invalid request");
 146             }
 147             $this->jok($this->update($x, $_REQUEST));
 148         } else {
 149
 150             if (empty($_POST)) {
 151                 $this->jerr("No data recieved for inserting");
 152             }
 153
 154             $this->jok($this->insert($x, $_REQUEST));
 155
 156         }
 157
 158
 159
 160     }
 161
 162     function delete($x, $req)
 163     {
 164         // do we really delete stuff!?!?!?
 165         if (empty($req['_delete'])) {
 166             $this->jerr("Delete Requested with no value");
 167         }
 168         // build a list of tables to queriy for dependant data..
 169         $map = $x->links();
 170
 171         $affects  = array();
 172
 173         $all_links = $x->databaseLinks();
 174
 175         foreach($all_links as $tbl => $links) {
 176             foreach($links as $col => $totbl_col) {
 177                 $to = explode(':', $totbl_col);
 178                 if ($to[0] != $x->tableName()) {
 179                     continue;
 180                 }
 181
 182                 $affects[$tbl .'.' . $col] = true;
 183             }
 184         }
 185         // collect tables
 186
 187        // echo '<PRE>';print_r($affects);exit;
 188        // DB_Dataobject::debugLevel(1);
 189
 190
 191         $clean = create_function('$v', 'return (int)$v;');
 192
 193         $bits = array_map($clean, explode(',', $req['_delete']));
 194
 195        // print_r($bits);exit;
 196
 197         // let's assume it has a key!!!
 198
 199
 200         $x->whereAdd($this->key .'  IN ('. implode(',', $bits) .')');
 201         if (!$x->find()) {
 202             $this->jerr("Nothing found to delete");
 203         }
 204         $errs = array();
 205         while ($x->fetch()) {
 206             $xx = clone($x);
 207
 208
 209             // perms first.
 210
 211             if (!$this->checkPerm($x,'D') )  {
 212                 $this->jerr("PERMISSION DENIED (d)");
 213             }
 214
 215             $match_ar = array();
 216             foreach($affects as $k=> $true) {
 217                 $ka = explode('.', $k);
 218
 219                 $chk = DB_DataObject::factory($ka[0]);
 220                 if (!is_a($chk,'DB_DataObject')) {
 221                     $this->jerr('Unable to load referenced table, check the links config: ' .$ka[0]);
 222                 }
 223                // print_r(array($chk->tablename() , $ka[1] ,  $xx->tablename() , $this->key ));
 224                 $chk->{$ka[1]} =  $xx->{$this->key};
 225
 226                 if (count($chk->keys())) {
 227                     $matches = $chk->count();
 228                 } else {
 229                     //DB_DataObject::DebugLevel(1);
 230                     $matches = $chk->count($ka[1]);
 231                 }
 232
 233                 if ($matches) {
 234                     $chk->_match_key = $ka[1];
 235                     $match_ar[] = clone($chk);
 236                     continue;
 237                 }
 238             }
 239
 240             $has_beforeDelete = method_exists($xx, 'beforeDelete');
 241             // before delte = allows us to trash dependancies if needed..
 242             $match_total = 0;
 243
 244             if ( $has_beforeDelete ) {
 245                 if ($xx->beforeDelete($match_ar, $this, $req) === false) {
 246                     $errs[] = "Delete failed ({$xx->id})\n".
 247                         (isset($xx->err) ? $xx->err : '');
 248                     continue;
 249                 }
 250                 // refetch affects..
 251
 252                 $match_ar = array();
 253                 foreach($affects as $k=> $true) {
 254                     $ka = explode('.', $k);
 255                     $chk = DB_DataObject::factory($ka[0]);
 256                     if (!is_a($chk,'DB_DataObject')) {
 257                         $this->jerr('Unable to load referenced table, check the links config: ' .$ka[0]);
 258                     }
 259                     $chk->{$ka[1]} =  $xx->{$this->key};
 260                     $matches = $chk->count();
 261                     $match_total += $matches;
 262                     if ($matches) {
 263                         $chk->_match_key = $ka[1];
 264                         $match_ar[] = clone($chk);
 265                         continue;
 266                     }
 267                 }
 268
 269             }
 270
 271             if (!empty($match_ar)) {
 272                 $chk = $match_ar[0];
 273                 $chk->limit(1);
 274                 $o = $chk->fetchAll();
 275                 $key = isset($chk->_match_key) ?$chk->_match_key  : '?unknown column?';
 276                 $desc =  $chk->tableName(). '.' . $key .'='.$xx->{$this->key} ;
 277                 if (method_exists($chk, 'toEventString')) {
 278                     $desc .=  ' : ' . $o[0]->toEventString();
 279                 }
 280
 281                 $this->jerr("Delete Dependant records ($match_total  found),  " .
 282                              "first is ( $desc )");
 283
 284             }
 285
 286             $this->logDeleteEvent($x);
 287
 288             $xx->delete();
 289
 290             if (method_exists($xx,'onDelete')) {
 291                 $xx->onDelete($req, $this);
 292             }
 293
 294
 295         }
 296         if ($errs) {
 297             $this->jerr(implode("\n<BR>", $errs));
 298         }
 299         $this->jok("Deleted");
 300
 301     }
 302
 303     function logDeleteEvent($object)
 304     {
 305
 306         DB_DataObject::Factory('Events')->logDeletedRecord($object);
 307
 308         $this->addEvent("DELETE", $object);
 309
 310
 311     }
 312
 313
 314     function update($x, $req,  $with_perm_check = true)
 315     {
 316         if ( $with_perm_check && !$this->checkPerm($x,'E', $req) )  {
 317             $this->jerr("PERMISSION DENIED - No Edit permissions on this element");
 318         }
 319
 320         // check any locks..
 321         // only done if we recieve a lock_id.
 322         // we are very trusing here.. that someone has not messed around with locks..
 323         // the object might want to check in their checkPerm - if locking is essential..
 324         $lock = $this->updateLock($x,$req);
 325
 326         $old = clone($x);
 327         $this->old = $x;
 328         // this lot is generic.. needs moving
 329         if (method_exists($x, 'setFromRoo')) {
 330             $res = $x->setFromRoo($req, $this);
 331             if (is_string($res)) {
 332                 $this->jerr($res);
 333             }
 334         } else {
 335             $x->setFrom($req);
 336         }
 337
 338
 339
 340         //echo '<PRE>';print_r($old);print_r($x);exit;
 341         //print_r($old);
 342
 343         $cols = $x->table();
 344         //print_r($cols);
 345         if (isset($cols['modified'])) {
 346             $x->modified = date('Y-m-d H:i:s');
 347         }
 348         if (isset($cols['modified_dt'])) {
 349             $x->modified_dt = date('Y-m-d H:i:s');
 350         }
 351         if (isset($cols['modified_by']) && $this->authUser) {
 352             $x->modified_by = $this->authUser->id;
 353         }
 354
 355         if (isset($cols['updated'])) {
 356             $x->updated = date('Y-m-d H:i:s');
 357         }
 358         if (isset($cols['updated_dt'])) {
 359             $x->updated_dt = date('Y-m-d H:i:s');
 360         }
 361         if (isset($cols['updated_by']) && $this->authUser) {
 362             $x->updated_by = $this->authUser->id;
 363         }
 364
 365         if (method_exists($x, 'beforeUpdate')) {
 366             $x->beforeUpdate($old, $req, $this);
 367         }
 368
 369         if ($with_perm_check && !empty($_FILES) && method_exists($x, 'onUpload')) {
 370             $x->onUpload($this, $_REQUEST);
 371         }
 372
 373         //DB_DataObject::DebugLevel(1);
 374         $res = $x->update($old);
 375         if ($res === false) {
 376             $this->jerr($x->_lastError->toString());
 377         }
 378
 379         if (method_exists($x, 'onUpdate')) {
 380             $x->onUpdate($old, $req, $this);
 381         }
 382         $ev = $this->addEvent("EDIT", $x);
 383         if ($ev) {
 384             $ev->audit($x, $old);
 385         }
 386
 387
 388         return $this->selectSingle(
 389             DB_DataObject::factory($x->tableName()),
 390             $x->{$this->key}
 391         );
 392
 393     }
 394
 395     function updateLock($x, $req )
 396     {
 397         $this->permitError = true; // allow it to fail without dieing
 398
 399         $lock = DB_DataObjecT::factory('core_locking');
 400         $this->permitError = false;
 401         if (is_a($lock,'DB_DataObject') && $this->authUser)  {
 402
 403             $lock->on_id = $x->{$this->key};
 404             $lock->on_table= strtolower($x->tableName());
 405             if (!empty($_REQUEST['_lock_id'])) {
 406                 $lock->whereAdd('id != ' . ((int)$_REQUEST['_lock_id']));
 407             } else {
 408                 $lock->whereAdd('person_id !=' . $this->authUser->id);
 409             }
 410
 411             $llc = clone($lock);
 412             $exp = date('Y-m-d', strtotime('NOW - 1 WEEK'));
 413             $llc->whereAdd("created < '$exp'");
 414             if ($llc->count()) {
 415                 $llc->find();
 416                 while($llc->fetch()) {
 417                     $llcd = clone($llc);
 418                     $llcd->delete();
 419                 }
 420             }
 421
 422             $lock->limit(1);
 423             if ($lock->find(true)) {
 424                 // it's locked by someone else..
 425                $p = $lock->person();
 426
 427
 428                $this->jerr( "Record was locked by " . $p->name . " at " .$lock->created.
 429                            " - Please confirm you wish to save"
 430                            , array('needs_confirm' => true));
 431
 432
 433             }
 434             // check the users lock.. - no point.. ??? - if there are no other locks and it's not the users, then they can
 435             // edit it anyways...
 436
 437             // can we find the user's lock.
 438             $lock = DB_DataObjecT::factory('core_locking');
 439             $lock->on_id = $x->{$this->key};
 440             $lock->on_table= strtolower($x->tableName());
 441             $lock->person_id = $this->authUser->id;
 442             $lock->orderBy('created DESC');
 443             $lock->limit(1);
 444
 445             if (
 446                     $lock->find(true) &&
 447                     isset($x->modified_dt) &&
 448                     strtotime($x->modified_dt) > strtotime($lock->created) &&
 449                     empty($req['_submit_confirmed']) &&
 450                     $x->modified_by != $this->authUser->id
 451                 )
 452             {
 453                 $p = DB_DataObject::factory('core_person');
 454                 $p->get($x->modified_by);
 455                 $this->jerr($p->name . " saved the record since you started editing,\nDo you really want to update it?", array('needs_confirm' => true));
 456
 457             }
 458         }
 459
 460         return $lock;
 461
 462     }
 463
 464     function insert($x, $req, $with_perm_check = true)
 465     {
 466         if (method_exists($x, 'setFromRoo')) {
 467             $res = $x->setFromRoo($req, $this);
 468             if (is_string($res)) {
 469                 $this->jerr($res);
 470             }
 471         } else {
 472             $x->setFrom($req);
 473         }
 474
 475         if ( $with_perm_check &&  !$this->checkPerm($x,'A', $req))  {
 476             $this->jerr("PERMISSION DENIED (i)");
 477         }
 478         $cols = $x->table();
 479
 480         if (isset($cols['created'])) {
 481             $x->created = date('Y-m-d H:i:s');
 482         }
 483         if (isset($cols['created_dt'])) {
 484             $x->created_dt = date('Y-m-d H:i:s');
 485         }
 486         if (isset($cols['created_by'])) {
 487             $x->created_by = $this->authUser->id;
 488         }
 489
 490
 491         if (isset($cols['modified'])) {
 492             $x->modified = date('Y-m-d H:i:s');
 493         }
 494         if (isset($cols['modified_dt'])) {
 495             $x->modified_dt = date('Y-m-d H:i:s');
 496         }
 497         if (isset($cols['modified_by'])) {
 498             $x->modified_by = $this->authUser->id;
 499         }
 500
 501         if (isset($cols['updated'])) {
 502             $x->updated = date('Y-m-d H:i:s');
 503         }
 504         if (isset($cols['updated_dt'])) {
 505             $x->updated_dt = date('Y-m-d H:i:s');
 506         }
 507         if (isset($cols['updated_by'])) {
 508             $x->updated_by = $this->authUser->id;
 509         }
 510
 511         if (method_exists($x, 'beforeInsert')) {
 512             $x->beforeInsert($_REQUEST, $this);
 513         }
 514
 515         $res = $x->insert();
 516         if ($res === false) {
 517             $this->jerr($x->_lastError->toString());
 518         }
 519         if (method_exists($x, 'onInsert')) {
 520             $x->onInsert($_REQUEST, $this);
 521         }
 522         $ev = $this->addEvent("ADD", $x);
 523         if ($ev) {
 524             $ev->audit($x);
 525         }
 526
 527         // note setFrom might handle this before hand...!??!
 528         if (!empty($_FILES) && method_exists($x, 'onUpload')) {
 529             $x->onUpload($this, $_REQUEST);
 530         }
 531
 532         return $this->selectSingle(
 533             DB_DataObject::factory($x->tableName()),
 534             $x->pid()
 535         );
 536
 537     }
 538 }