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

   1 <?php
   2
   3 trait Pman_Core_RooGetTrait {
   4     /**
   5      * GET method   Roo/TABLENAME.php
   6      *
   7      * Generally for SELECT or Single SELECT
   8      *
   9      * Single SELECT:
  10      *    _id=value          single fetch based on primary id.
  11      *                       can be '0' if you want to fetch a set of defaults
  12      *                       Use in conjuntion with toRooSingleArray()
  13      *
  14      *    lookup[key]=value  single fetch based on a single key value lookup.
  15      *                       multiple key/value can be used. eg. ontable+onid..
  16      *    _columns           what to return.
  17      *
  18      *
  19      * JOINS:
  20      *  - all tables are always autojoined.
  21      *
  22      * Search SELECT
  23      *    COLUMNS to fetch
  24      *      _columns=a,b,c,d     comma seperated list of columns.
  25      *      _columns_exclude=a,b,c,d   comma seperated list of columns.
  26      *      _distinct=name        a distinct column lookup. you also have to use _columns with this.
  27      *
  28      *    WHERE (searches)
  29      *       colname = ...              => colname = ....
  30      *       !colname=....                 => colname != ....
  31      *       !colname[0]=... !colname[1]=... => colname NOT IN (.....) ** only supports main table at present..
  32      *       colname[0]=... colname[1]=... => colname IN (.....) ** only supports main table at present..
  33      *
  34      *    ORDER BY
  35      *       sort=name          what to sort.
  36      *       sort=a,b,d         can support multiple columns
  37      *       dir=ASC            what direction
  38      *       _multisort ={...}  JSON encoded { sort : { row : direction }, order : [ row, row, row ] }
  39      *
  40      *    LIMIT
  41      *      start=0         limit start
  42      *      limit=25        limit number
  43      *
  44      *
  45      *    Simple CSV support
  46      *      csvCols[0] csvCols[1]....    = .... column titles for CSV output
  47      *      csvTitles[0], csvTitles[1] ....  = columns to use for CSV output
  48      *
  49      *  Depricated
  50      *      _toggleActive !:!:!:! - this hsould not really be here..
  51      *      query[add_blank] - add a line in with an empty option...  - not really needed???
  52      *      _delete    = delete a list of ids element. (depricated.. this will be removed...)
  53      *
  54      * DEBUGGING
  55      *  _post   =1    = simulate a post with debuggin on.
  56      *  _debug_post << This is prefered, as _post may overlap with accouting posts..
  57      *
  58      *  _debug     = turn on DB_dataobject deubbing, must be admin at present..
  59      *
  60      *
  61      * CALLS methods on dataobjects if they exist
  62      *
  63      *
  64      *   checkPerm('S' , $authuser)
  65      *                      - can we list the stuff
  66      *                      - return false to disallow...
  67      *   applySort($au, $sortcol, $direction, $array_of_columns, $multisort)
  68      *                     -- does not support multisort at present..
  69      *   applyFilters($_REQUEST, $authUser, $roo)
  70      *                     -- apply any query filters on data. and hide stuff not to be seen.
  71      *                     -- can exit by calling $roo->jerr()
  72      *   postListExtra($_REQUEST) : array(extra_name => data)
  73      *                     - add extra column data on the results (like new messages etc.)
  74      *   postListFilter($data, $authUser, $request) return $data
  75      *                      - add extra data to an object
  76      *
  77      *
  78      *   toRooSingleArray($authUser, $request) : array
  79      *                       - called on single fetch only, add or maniuplate returned array data.
  80      *                       - is also called when _id=0 is used (for fetching a default set.)
  81      *   toRooArray($request) : array
  82      *                      - called if singleArray is unavailable on single fetch.
  83      *                      - always tried for mutiple results.
  84      *   toArray()          - the default method if none of the others are found.
  85      *
  86      *   autoJoin($request)
  87      *                      - standard DataObject feature - causes all results to show all
  88      *                        referenced data.
  89      *
  90      * PROPERTIES:
  91      *    _extra_cols  -- if set, then filtering by column etc. will use them.
  92      *
  93
  94      */
  95     function get($tab)
  96     {
  97         $this->init();
  98
  99         HTML_FlexyFramework::get()->generateDataobjectsCache($this->isDev);
 100
 101         if ( $this->checkDebugPost()) {
 102             $_POST  = $_GET;
 103             return $this->post($tab);
 104         }
 105
 106         $this->checkDebug();
 107
 108         PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
 109
 110         $tab = array_shift(explode('/', $tab));
 111
 112         $x = $this->dataObject($tab);
 113
 114         $_columns = !empty($_REQUEST['_columns']) ? explode(',', $_REQUEST['_columns']) : false;
 115
 116         if (isset( $_REQUEST['lookup'] ) && is_array($_REQUEST['lookup'] )) { // single fetch based on key/value pairs
 117              $this->selectSingle($x, $_REQUEST['lookup'],$_REQUEST);
 118              // actually exits.
 119         }
 120
 121
 122         // single fetch (use '0' to fetch an empty object..)
 123         if (isset($_REQUEST['_id']) && is_numeric($_REQUEST['_id'])) {
 124
 125              $this->selectSingle($x, $_REQUEST['_id'],$_REQUEST);
 126              // actually exits.
 127         }
 128
 129         // Depricated...
 130
 131
 132         if (isset($_REQUEST['_delete'])) {
 133             $this->jerr("DELETE by GET has been removed - update the code to use POST");
 134         }
 135
 136
 137         // Depricated...
 138
 139         if (isset($_REQUEST['_toggleActive'])) {
 140             // do we really delete stuff!?!?!?
 141             if (!$this->hasPerm("Core.Staff", 'E'))  {
 142                 $this->jerr("PERMISSION DENIED (ta)");
 143             }
 144             $clean = create_function('$v', 'return (int)$v;');
 145             $bits = array_map($clean, explode(',', $_REQUEST['_toggleActive']));
 146             if (in_array($this->authUser->id, $bits) && $this->authUser->active) {
 147                 $this->jerr("you can not disable yourself");
 148             }
 149             $x->query('UPDATE Person SET active = !active WHERE id IN (' .implode(',', $bits).')');
 150             $this->addEvent("USERTOGGLE", false, implode(',', $bits));
 151             $this->jok("Updated");
 152
 153         }
 154        //DB_DataObject::debugLevel(1);
 155
 156
 157         // sets map and countWhat
 158         $this->loadMap($x, array(
 159             'columns' => $_columns,
 160             'distinct' => empty($_REQUEST['_distinct']) ? false:  $_REQUEST['_distinct'],
 161             'exclude' => empty($_REQUEST['_exclude_columns']) ? false:  explode(',', $_REQUEST['_exclude_columns'])
 162         ));
 163
 164
 165         $this->setFilters($x,$_REQUEST);
 166
 167         if (!$this->checkPerm($x,'S', $_REQUEST))  {
 168             $this->jerr("PERMISSION DENIED (g)");
 169         }
 170
 171         $total = $x->count($this->countWhat);
 172         // sorting..
 173       //
 174         //var_dump($total);exit;
 175         $this->applySort($x);
 176
 177         $fake_limit = false;
 178
 179         if (!empty($_REQUEST['_distinct']) && $total < 400) {
 180             $fake_limit  = true;
 181         }
 182
 183         if (!$fake_limit) {
 184
 185             $x->limit(
 186                 empty($_REQUEST['start']) ? 0 : (int)$_REQUEST['start'],
 187                 min(empty($_REQUEST['limit']) ? 25 : (int)$_REQUEST['limit'], 10000)
 188             );
 189         }
 190         $queryObj = clone($x);
 191         //DB_DataObject::debuglevel(1);
 192
 193         $this->sessionState(0);
 194         $res = $x->find();
 195         $this->sessionState(1);
 196
 197         if (false === $res) {
 198             $this->jerr($x->_lastError->toString());
 199
 200         }
 201
 202
 203
 204         $ret = array();
 205
 206         // ---------------- THESE ARE DEPRICATED.. they should be moved to the model...
 207
 208
 209         if (!empty($_REQUEST['query']['add_blank'])) {
 210             $ret[] = array( 'id' => 0, 'name' => '----');
 211             $total+=1;
 212         }
 213
 214         $rooar = method_exists($x, 'toRooArray');
 215         $_columnsf = $_columns  ? array_flip($_columns) : false;
 216         while ($x->fetch()) {
 217             //print_R($x);exit;
 218             $add = $rooar  ? $x->toRooArray($_REQUEST) : $x->toArray();
 219             if ($add === false) {
 220                 continue;
 221             }
 222             $ret[] =  !$_columns ? $add : array_intersect_key($add, $_columnsf);
 223         }
 224
 225         if ($fake_limit) {
 226             $ret = array_slice($ret,
 227                    empty($_REQUEST['start']) ? 0 : (int)$_REQUEST['start'],
 228                     min(empty($_REQUEST['limit']) ? 25 : (int)$_REQUEST['limit'], 10000)
 229             );
 230
 231         }
 232
 233
 234         $extra = false;
 235         if (method_exists($queryObj ,'postListExtra')) {
 236             $extra = $queryObj->postListExtra($_REQUEST, $this);
 237         }
 238
 239
 240         // filter results, and add any data that is needed...
 241         if (method_exists($x,'postListFilter')) {
 242             $ret = $x->postListFilter($ret, $this->authUser, $_REQUEST);
 243         }
 244
 245
 246
 247         if (!empty($_REQUEST['csvCols']) && !empty($_REQUEST['csvTitles']) ) {
 248
 249
 250             $this->toCsv($ret, $_REQUEST['csvCols'], $_REQUEST['csvTitles'],
 251                         empty($_REQUEST['csvFilename']) ? '' : $_REQUEST['csvFilename']
 252                          );
 253
 254
 255
 256         }
 257         //die("DONE?");
 258
 259         //if ($x->tableName() == 'Documents_Tracking') {
 260         //    $ret = $this->replaceSubject(&$ret, 'doc_id_subject');
 261        // }
 262
 263
 264
 265         if (!empty($_REQUEST['_requestMeta']) &&  count($ret)) {
 266             $meta = $this->meta($x, $ret);
 267             if ($meta) {
 268                 $extra['metaData'] = $meta;
 269             }
 270         }
 271         // this make take some time...
 272         $this->sessionState(0);
 273        // echo "<PRE>"; print_r($ret);
 274         $this->jdata($ret, max(count($ret), $total), $extra );
 275
 276
 277     }
 278
 279     function checkDebugPost()
 280     {
 281         return (!empty($_GET['_post']) || !empty($_GET['_debug_post'])) &&
 282                     $this->authUser &&
 283                     method_exists($this->authUser,'groups') &&
 284                     in_array('Administrators', $this->authUser->groups('name'));
 285
 286     }
 287
 288     function selectSingle($x, $id, $req=false)
 289     {
 290         $_columns = !empty($req['_columns']) ? explode(',', $req['_columns']) : false;
 291
 292         if (!is_array($id) && empty($id)) {
 293
 294             if (method_exists($x, 'toRooSingleArray')) {
 295                 $this->jok($x->toRooSingleArray($this->getAuthUser(), $req));
 296             }
 297
 298             if (method_exists($x, 'toRooArray')) {
 299                 $this->jok($x->toRooArray($req));
 300             }
 301
 302             $this->jok($x->toArray());
 303         }
 304
 305
 306         $this->loadMap($x, array(
 307             'columns' => $_columns,
 308         ));
 309
 310         if ($req !== false) {
 311             $this->setFilters($x, $req);
 312         }
 313
 314         if (is_array($id)) {
 315             // lookup...
 316             $x->setFrom($req['lookup'] );
 317             $x->limit(1);
 318             if (!$x->find(true)) {
 319                 if (!empty($id['_id'])) {
 320                     // standardize this?
 321                     $this->jok($x->toArray());
 322                 }
 323                 $this->jok(false);
 324             }
 325
 326         } else if (!$x->get($id)) {
 327             $this->jerr("selectSingle: no such record ($id)");
 328         }
 329
 330         // ignore perms if comming from update/insert - as it's already done...
 331         if ($req !== false && !$this->checkPerm($x,'S'))  {
 332             $this->jerr("PERMISSION DENIED - si");
 333         }
 334         // different symantics on all these calls??
 335         if (method_exists($x, 'toRooSingleArray')) {
 336             $this->jok($x->toRooSingleArray($this->getAuthUser(), $req));
 337         }
 338         if (method_exists($x, 'toRooArray')) {
 339             $this->jok($x->toRooArray($req));
 340         }
 341
 342         $this->jok($x->toArray());
 343
 344
 345     }
 346
 347     function setFilters($x, $q)
 348     {
 349         if (method_exists($x, 'applyFilters')) {
 350            // DB_DataObject::debugLevel(1);
 351             if (false === $x->applyFilters($q, $this->getAuthUser(), $this)) {
 352                 return;
 353             }
 354         }
 355         $q_filtered = array();
 356
 357         $keys = $x->keys();
 358         // var_dump($keys);exit;
 359         foreach($q as $key=>$val) {
 360
 361             if (in_array($key,$keys) && !is_array($val)) {
 362
 363                 $x->$key  = $val;
 364             }
 365
 366              // handles name[]=fred&name[]=brian => name in ('fred', 'brian').
 367             // value is an array..
 368             if (is_array($val) ) {
 369
 370                 $pref = '';
 371
 372                 if ($key[0] == '!') {
 373                     $pref = '!';
 374                     $key = substr($key,1);
 375                 }
 376
 377                 if (!in_array( $key,  array_keys($this->cols))) {
 378                     continue;
 379                 }
 380
 381                 // support a[0] a[1] ..... => whereAddIn(
 382                 $ar = array();
 383                 $quote = false;
 384                 foreach($val as $k=>$v) {
 385                     if (!is_numeric($k)) {
 386                         $ar = array();
 387                         break;
 388                     }
 389                     // FIXME: note this is not typesafe for anything other than mysql..
 390
 391                     if (!is_numeric($v) || !is_long($v)) {
 392                         $quote = true;
 393                     }
 394                     $ar[] = $v;
 395
 396                 }
 397                 if (count($ar)) {
 398
 399
 400                     $x->whereAddIn($pref . (
 401                         isset($this->colsJname[$key]) ?
 402                             $this->colsJname[$key] :
 403                             ($x->tableName(). '.'.$key)),
 404                         $ar, $quote ? 'string' : 'int');
 405                 }
 406
 407                 continue;
 408             }
 409
 410
 411             // handles !name=fred => name not equal fred.
 412             if ($key[0] == '!' && in_array(substr($key, 1), array_keys($this->cols))) {
 413
 414                 $key  = substr($key, 1) ;
 415
 416                 $x->whereAdd(   (
 417                         isset($this->colsJname[$key]) ?
 418                             $this->colsJname[$key] :
 419                             $x->tableName(). '.'.$key ) . ' != ' .
 420                     (is_numeric($val) ? $val : "'".  $x->escape($val) . "'")
 421                 );
 422                 continue;
 423
 424             }
 425
 426             switch($key) {
 427
 428                 // Events and remarks -- fixme - move to events/remarsk...
 429                 case 'on_id':  // where TF is this used...
 430                     if (!empty($q['query']['original'])) {
 431                       //  DB_DataObject::debugLevel(1);
 432                         $o = (int) $q['query']['original'];
 433                         $oid = (int) $val;
 434                         $x->whereAdd("(on_id = $oid  OR
 435                                 on_id IN ( SELECT distinct(id) FROM Documents WHERE original = $o )
 436                             )");
 437                         continue;
 438
 439                     }
 440                     $x->on_id = $val;
 441
 442
 443                 default:
 444                     if (strlen($val) && $key[0] != '_') {
 445                         $q_filtered[$key] = $val;
 446                     }
 447
 448                     // subjoined columns = check the values.
 449                     // note this is not typesafe for anything other than mysql..
 450
 451                     if (isset($this->colsJname[$key])) {
 452                         $quote = false;
 453                         if (!is_numeric($val) || !is_long($val)) {
 454                             $quote = true;
 455                         }
 456                         $x->whereAdd( "{$this->colsJname[$key]} = " . ($quote ? "'". $x->escape($val) ."'" : $val));
 457
 458                     }
 459
 460
 461                     continue;
 462             }
 463         }
 464         if (!empty($q_filtered)) {
 465             $x->setFrom($q_filtered);
 466         }
 467
 468         if (!empty($q['query']['name'])) {
 469             if (in_array( 'name',  array_keys($x->table()))) {
 470                 $x->whereAdd($x->tableName().".name LIKE '". $x->escape($q['query']['name']) . "%'");
 471             }
 472         }
 473
 474     }
 475
 476     function applySort($x, $sort = '', $dir ='')
 477     {
 478         $sort = empty($_REQUEST['sort']) ? $sort : $_REQUEST['sort'];
 479         $dir = empty($_REQUEST['dir']) ? $dir : $_REQUEST['dir'];
 480         $dir = $dir == 'ASC' ? 'ASC' : 'DESC';
 481
 482         $ms = empty($_REQUEST['_multisort']) ? false : $_REQUEST['_multisort'];
 483         //var_Dump($ms);exit;
 484         $sorted = false;
 485         if (method_exists($x, 'applySort')) {
 486             $sorted = $x->applySort(
 487                     $this->getAuthUser(),
 488                     $sort,
 489                     $dir,
 490                     array_keys($this->cols),
 491                     $ms ? json_decode($ms) : false
 492             );
 493         }
 494         if ($ms !== false) {
 495             return $this->multiSort($x);
 496         }
 497
 498         if ($sorted === false) {
 499
 500             $cols = $x->table();
 501             $excols = array_keys($this->cols);
 502
 503             if (isset($x->_extra_cols)) {
 504                 $excols = array_merge($excols, $x->_extra_cols);
 505             }
 506             $sort_ar = explode(',', $sort);
 507             $sort_str = array();
 508
 509             foreach($sort_ar as $sort) {
 510
 511                 if (strlen($sort) && isset($cols[$sort]) ) {
 512                     $sort_str[] =  $x->tableName() .'.'.$sort . ' ' . $dir ;
 513
 514                 } else if (in_array($sort, $excols)) {
 515                     $sort_str[] = $sort . ' ' . $dir ;
 516                 }
 517             }
 518
 519             if ($sort_str) {
 520                 $x->orderBy(implode(', ', $sort_str ));
 521             }
 522         }
 523     }
 524 }