git.roojs.org Git - Pman.Base/blob - Pman.php

   1 <?php
   2 /**
   3  * Pman Base class
   4  *
   5  * Provides:
   6  *  - base application setup (variables etc to javascript)
   7  *
   8  *  - authentication and permission info about user / application
   9  *  - json output methods.
  10  *  - file upload error checking - checkFileUploadError
  11  *  - logging to event table
  12  *  - sendTemplate code (normally use the Person version for sending to specific people..)
  13  *
  14  *  - doc managment code?? - remarks and tracking??? - MOVEME
  15  *  - authentication link checking?? MOVEME?
  16  *  - authentication reset password ?? MOVEME?
  17  *  ?? arrayClean.. what's it doing here?!? ;)
  18  *
  19  *
  20  */
  21
  22 class Pman extends HTML_FlexyFramework_Page
  23 {
  24     var $appName= "";
  25     var $appShortName= "";
  26     var $appVersion = "1.8";
  27     var $version = 'dev';
  28     var $onloadTrack = 0;
  29     var $linkFail = "";
  30     var $showNewPass = 0;
  31     var $logoPrefix = '';
  32     var $appModules = '';
  33
  34
  35
  36
  37     /**
  38      * ------------- Standard getAuth/get/post methods of framework.
  39      *
  40      *
  41      */
  42
  43     function getAuth() // everyone allowed in!!!!!
  44     {
  45         $this->loadOwnerCompany();
  46
  47         return true;
  48
  49     }
  50
  51     function init()
  52     {
  53         if (isset($this->_hasInit)) {
  54             return;
  55         }
  56         $this->_hasInit = true;
  57
  58         $boot = HTML_FlexyFramework::get();
  59         // echo'<PRE>';print_R($boot);exit;
  60         $this->appName= $boot->appName;
  61         $this->appNameShort= $boot->appNameShort;
  62         $this->appModules= $boot->enable;
  63         $this->isDev = empty($boot->Pman['isDev']) ? false : $boot->Pman['isDev'];
  64         $this->appDisable = $boot->disable;
  65         $this->version = $boot->version;
  66
  67         if (!empty($ff->Pman['local_autoauth']) &&
  68             ($_SERVER['SERVER_ADDR'] == '127.0.0.1') &&
  69             ($_SERVER['REMOTE_ADDR'] == '127.0.0.1')
  70         ) {
  71             $this->isDev = true;
  72         }
  73
  74
  75     }
  76
  77     function get($base)
  78     {
  79         $this->init();
  80             //$this->allowSignup= empty($opts['allowSignup']) ? 0 : 1;
  81         $bits = explode('/', $base);
  82         //print_R($bits);
  83         if ($bits[0] == 'Link') {
  84             $this->linkFail = $this->linkAuth(@$bits[1],@$bits[2]);
  85             header('Content-type: text/html; charset=utf-8');
  86             return;
  87         }
  88         if ($bits[0] == 'PasswordReset') {
  89             $this->linkFail = $this->resetPassword(@$bits[1],@$bits[2],@$bits[3]);
  90             header('Content-type: text/html; charset=utf-8');
  91             return;
  92         }
  93
  94
  95         if ($this->getAuthUser()) {
  96             $this->addEvent("RELOAD");
  97         }
  98
  99
 100         if (strlen($base)) {
 101             $this->addEvent("BADURL", false, $base);
 102             $this->jerr("invalid url");
 103         }
 104         // deliver template
 105         if (isset($_GET['onloadTrack'])) {
 106             $this->onloadTrack = (int)$_GET['onloadTrack'];
 107         }
 108         // getting this to work with xhtml is a nightmare
 109         // = nbsp / <img> issues screw everyting up.
 110         $dev = $this->isDev;
 111
 112         // force regeneration on load for development enviroments..
 113         HTML_FlexyFramework::get()->generateDataobjectsCache($this->isDev);
 114
 115         //header('Content-type: application/xhtml+xml; charset=utf-8');
 116         header('Content-type: text/html; charset=utf-8');
 117
 118     }
 119     function post($base) {
 120         return $this->get($base);
 121     }
 122
 123     /**
 124      * ------------- Authentication and permission info about logged in user!!!
 125      *
 126      *
 127      */
 128
 129     function loadOwnerCompany()
 130     {
 131         $this->company = DB_DataObject::Factory('Companies');
 132         if ($this->company) { // non-core pman projects
 133             return;
 134         }
 135         $this->company->get('comptype', 'OWNER');
 136
 137     }
 138     function staticGetAuthUser()
 139     {
 140         $ff = HTML_FlexyFramework::get();
 141         $tbl = empty($ff->Pman['authTable']) ? 'Person' : $ff->Pman['authTable'];
 142
 143         $u = DB_DataObject::factory($tbl);
 144         if (!$u->isAuth()) {
 145             return false;
 146         }
 147         return $u->getAuthUser();
 148     }
 149     function getAuthUser()
 150     {
 151         if (!empty($this->authUser)) {
 152             return $this->authUser;
 153         }
 154         $ff = HTML_FlexyFramework::get();
 155         $tbl = empty($ff->Pman['authTable']) ? 'Person' : $ff->Pman['authTable'];
 156
 157         $u = DB_DataObject::factory( $tbl );
 158         if (!$u->isAuth()) {
 159             return false;
 160         }
 161         $this->authUser =$u->getAuthUser();
 162         return $this->authUser ;
 163     }
 164     function hasPerm($name, $lvl)  // do we have a permission
 165     {
 166         static $pcache = array();
 167         $au = $this->getAuthUser();
 168         return $au->hasPerm($name,$lvl);
 169
 170     }
 171     function hasModule($name)
 172     {
 173         $this->init();
 174         if (!strpos( $name,'.') ) {
 175             // use enable / disable..
 176
 177
 178             $enabled =  array('Core') ;
 179             $enabled = !empty($this->appModules) ?
 180                 array_merge($enabled, explode(',',  $this->appModules)) :
 181                 $enabled;
 182             $disabled =  explode(',', $this->appDisable ? $this->appDisable: '');
 183
 184             //print_R($opts);
 185
 186             return in_array($name, $enabled) && !in_array($name, $disabled);
 187         }
 188
 189         $x = DB_DataObject::factory('Group_Rights');
 190         $ar = $x->defaultPermData();
 191         if (empty($ar[$name]) || empty($ar[$name][0])) {
 192             return false;
 193         }
 194         return true;
 195     }
 196
 197
 198
 199
 200     /**
 201      * ---------------- Global Tools ---------------
 202      */
 203
 204
 205
 206     /**
 207      * send a template to the user
 208      * rcpts are read from the resulting template.
 209      *
 210      * @arg $templateFile  - the file in mail/XXXXXX.txt
 211      * @arg $args  - variables available to the form as {t.*} over and above 'this'
 212      *
 213      *
 214      */
 215
 216     function sendTemplate($templateFile, $args)
 217     {
 218
 219
 220
 221         $content  = clone($this);
 222
 223         foreach((array)$args as $k=>$v) {
 224             $content->$k = $v;
 225         }
 226         $content->msgid = md5(time() . rand());
 227
 228         $content->HTTP_HOST = $_SERVER["HTTP_HOST"];
 229         /* use the regex compiler, as it doesnt parse <tags */
 230         require_once 'HTML/Template/Flexy.php';
 231         $template = new HTML_Template_Flexy( array(
 232                  'compiler'    => 'Regex',
 233                  'filters' => array('SimpleTags','Mail'),
 234             //     'debug'=>1,
 235             ));
 236
 237         // this should be done by having multiple template sources...!!!
 238
 239         $template->compile('mail/'. $templateFile.'.txt');
 240
 241         /* use variables from this object to ouput data. */
 242         $mailtext = $template->bufferedOutputObject($content);
 243         //echo "<PRE>";print_R($mailtext);
 244
 245         /* With the output try and send an email, using a few tricks in Mail_MimeDecode. */
 246         require_once 'Mail/mimeDecode.php';
 247         require_once 'Mail.php';
 248
 249         $decoder = new Mail_mimeDecode($mailtext);
 250         $parts = $decoder->getSendArray();
 251         if (PEAR::isError($parts)) {
 252             return $parts;
 253             //echo "PROBLEM: {$parts->message}";
 254             //exit;
 255         }
 256         list($recipents,$headers,$body) = $parts;
 257         ///$recipents = array($this->email);
 258         $mailOptions = PEAR::getStaticProperty('Mail','options');
 259         $mail = Mail::factory("SMTP",$mailOptions);
 260         $headers['Date'] = date('r');
 261         if (PEAR::isError($mail)) {
 262             return $mail;
 263         }
 264         $oe = error_reporting(E_ALL ^ E_NOTICE);
 265         $ret = $mail->send($recipents,$headers,$body);
 266         error_reporting($oe);
 267
 268         return $ret;
 269
 270     }
 271
 272     function checkFileUploadError()  // check for file upload errors.
 273     {
 274         if (
 275             empty($_FILES['File'])
 276             || empty($_FILES['File']['name'])
 277             || empty($_FILES['File']['tmp_name'])
 278             || empty($_FILES['File']['type'])
 279             || !empty($_FILES['File']['error'])
 280             || empty($_FILES['File']['size'])
 281         ) {
 282             $this->jerr("File upload error: <PRE>" . print_r($_FILES,true) . print_r($_POST,true) . "</PRE>");
 283         }
 284     }
 285
 286
 287     /**
 288      * generate a tempory file with an extension (dont forget to delete it)
 289      */
 290
 291     function tempName($ext)
 292     {
 293         $x = tempnam(ini_get('session.save_path'), HTML_FlexyFramework::get()->appNameShort.'TMP');
 294         unlink($x);
 295         return $x .'.'. $ext;
 296     }
 297     /**
 298      * ------------- Authentication testing ------ ??? MOVEME?
 299      *
 300      *
 301      */
 302     function linkAuth($trid, $trkey)
 303     {
 304         $tr = DB_DataObject::factory('Documents_Tracking');
 305         if (!$tr->get($trid)) {
 306             return "Invalid URL";
 307         }
 308         if (strtolower($tr->authkey) != strtolower($trkey)) {
 309             $this->AddEvent("ERROR-L", false, "Invalid Key");
 310             return "Invalid KEY";
 311         }
 312         // check date..
 313         $this->onloadTrack = (int) $tr->doc_id;
 314         if (strtotime($tr->date_sent) < strtotime("NOW - 14 DAYS")) {
 315             $this->AddEvent("ERROR-L", false, "Key Expired");
 316             return "Key Expired";
 317         }
 318         // user logged in and not
 319         $au = $this->getAuthUser();
 320         if ($au && $au->id && $au->id != $tr->person_id) {
 321             $au->logout();
 322
 323             return "Logged Out existing Session\n - reload to log in with correct key";
 324         }
 325         if ($au) { // logged in anyway..
 326             $this->AddEvent("LOGIN", false, "With Key (ALREADY)");
 327             header('Location: ' . $this->baseURL.'?onloadTrack='.$this->onloadTrack);
 328             exit;
 329             return false;
 330         }
 331
 332         // authenticate the user...
 333         // slightly risky...
 334         $u = DB_DataObject::factory('Person');
 335
 336         $u->get($tr->person_id);
 337         $u->login();
 338         $this->AddEvent("LOGIN", false, "With Key");
 339
 340         // we need to redirect out - otherwise refererer url will include key!
 341         header('Location: ' . $this->baseURL.'?onloadTrack='.$this->onloadTrack);
 342         exit;
 343
 344         return false;
 345
 346
 347
 348
 349     }
 350
 351
 352     /**
 353      * ------------- Authentication password reset ------ ??? MOVEME?
 354      *
 355      *
 356      */
 357
 358
 359     function resetPassword($id,$t, $key)
 360     {
 361
 362         $au = $this->getAuthUser();
 363         if ($au) {
 364             return "Already Logged in - no need to use Password Reset";
 365         }
 366
 367         $u = DB_DataObject::factory('Person');
 368         //$u->company_id = $this->company->id;
 369         $u->active = 1;
 370         if (!$u->get($id) || !strlen($u->passwd)) {
 371             return "invalid id";
 372         }
 373
 374         // validate key..
 375         if ($key != $u->genPassKey($t)) {
 376             return "invalid key";
 377         }
 378         $uu = clone($u);
 379         $u->no_reset_sent = 0;
 380         $u->update($uu);
 381
 382         if ($t < strtotime("NOW - 1 DAY")) {
 383             return "expired";
 384         }
 385         $this->showNewPass = implode("/", array($id,$t,$key));
 386         return false;
 387     }
 388
 389
 390     /**
 391      * ---------------- Standard JSON outputers. - used everywhere
 392      */
 393
 394     function jerr($str, $errors=array()) // standard error reporting..
 395     {
 396         require_once 'Services/JSON.php';
 397         $json = new Services_JSON();
 398
 399         if (!empty($_REQUEST['returnHTML']) ||
 400             (isset($_SERVER['CONTENT_TYPE']) && preg_match('#multipart/form-data#i', $_SERVER['CONTENT_TYPE']))
 401         ) {
 402             header('Content-type: text/html');
 403             echo "<HTML><HEAD></HEAD><BODY>";
 404             echo  $json->encodeUnsafe(array(
 405                     'success'=> false,
 406                     'errorMsg' => $str,
 407                      'message' => $str, // compate with exeption / loadexception.
 408
 409                     'errors' => $errors ? $errors : true, // used by forms to flag errors.
 410                     'authFailure' => !empty($errors['authFailure']),
 411                 ));
 412             echo "</BODY></HTML>";
 413             exit;
 414         }
 415
 416         echo $json->encode(array(
 417             'success'=> false,
 418             'data'=> array(),
 419             'errorMsg' => $str,
 420             'message' => $str, // compate with exeption / loadexception.
 421             'errors' => $errors ? $errors : true, // used by forms to flag errors.
 422             'authFailure' => !empty($errors['authFailure']),
 423         ));
 424         exit;
 425
 426     }
 427     function jok($str)
 428     {
 429
 430         require_once 'Services/JSON.php';
 431         $json = new Services_JSON();
 432
 433         if (!empty($_REQUEST['returnHTML']) ||
 434             (isset($_SERVER['CONTENT_TYPE']) && preg_match('#multipart/form-data#i', $_SERVER['CONTENT_TYPE']))
 435
 436         ) {
 437             header('Content-type: text/html');
 438             echo "<HTML><HEAD></HEAD><BODY>";
 439             echo  $json->encodeUnsafe(array('success'=> true, 'data' => $str));
 440             echo "</BODY></HTML>";
 441             exit;
 442         }
 443
 444
 445         echo  $json->encode(array('success'=> true, 'data' => $str));
 446         exit;
 447
 448     }
 449     /**
 450      * output data for grids or tree
 451      * @ar {Array} ar Array of data
 452      * @total {Number|false} total number of records (or false to return count(ar)
 453      * @extra {Array} extra key value list of data to pass as extra data.
 454      *
 455      */
 456     function jdata($ar,$total=false, $extra=array())
 457     {
 458         // should do mobile checking???
 459         if ($total == false) {
 460             $total = count($ar);
 461         }
 462         $extra=  $extra ? $extra : array();
 463         require_once 'Services/JSON.php';
 464         $json = new Services_JSON();
 465         echo $json->encode(array('success' =>  true, 'total'=> $total, 'data' => $ar) + $extra);
 466         exit;
 467
 468
 469     }
 470
 471
 472
 473
 474
 475     /**
 476      * ---------------- Page output?!?!?
 477      */
 478
 479
 480     function hasBg($fn) // used on front page to check if logos exist..
 481     {
 482         return file_exists($this->rootDir.'/Pman/'.$this->appNameShort.'/templates/images/'.  $fn);
 483     }
 484
 485     function outputJavascriptIncludes() // includes on devel version..
 486     {
 487
 488         $mods = explode(',', $this->appModules);
 489         array_unshift($mods,   'Core');
 490         $mods = array_unique($mods);
 491
 492
 493         $disabled =  explode(',', $this->appDisable ? $this->appDisable: '');
 494
 495         foreach($mods as $mod) {
 496             // add the css file..
 497             if (in_array($mod, $disabled)) {
 498                 continue;
 499             }
 500
 501
 502             $files = $this->moduleJavascriptList($mod.'/widgets');
 503             foreach($files as $f) {
 504                 echo '<script type="text/javascript" src="'. $f. '"></script>'."\n";
 505             }
 506
 507             $files = $this->moduleJavascriptList($mod);
 508             foreach($files as $f) {
 509                 echo '<script type="text/javascript" src="'. $f. '"></script>'."\n";
 510             }
 511
 512         }
 513
 514     }
 515
 516     function outputCSSIncludes() // includes on CSS links.
 517     {
 518
 519         $mods = explode(',', $this->appModules);
 520         array_unshift($mods,   'Core');
 521         $mods = array_unique($mods);
 522
 523         foreach($mods as $mod) {
 524             // add the css file..
 525             $css = $this->rootDir.'/Pman/'.$mod.'/'.strtolower($mod).'.css';
 526             if (file_exists( $css)){
 527                 $css = $this->rootURL .'/Pman/'.$mod.'/'.strtolower($mod).'.css';
 528                 echo '<link rel="stylesheet" type="text/css" href="'.$css.'" />'."\n";
 529             }
 530
 531
 532         }
 533
 534     }
 535
 536
 537
 538
 539     function moduleJavascriptList($mod)
 540     {
 541
 542         $ff = HTML_FlexyFramework::get();
 543
 544         $dir =   $this->rootDir.'/Pman/'. $mod;
 545
 546         $path =    $this->rootURL."/Pman/$mod/";
 547         $base = dirname($_SERVER['SCRIPT_FILENAME']);
 548         $cfile = realpath($base .'/_compiled_/' . $mod);
 549         $lfile = realpath($base .'/_translations_/' . $mod .  '.js');
 550         //    var_dump($cfile);
 551         if (!file_exists($dir)) {
 552
 553             return array();
 554         }
 555         $dh = opendir($dir);
 556         $maxtime = 0;
 557         $ctime = 0;
 558         $files = array();
 559         if (file_exists($cfile)) {
 560            // $ctime = max(filemtime($cfile), filectime($cfile));
 561             // otherwise use compile dfile..
 562             $cfile = basename(array_pop(glob($cfile . '/' . $mod . '*.js')));
 563
 564             $files = array( $this->rootURL. "/_compiled_/".$mod . "/" . $cfile);
 565             if (file_exists($lfile)) {
 566                 array_push($files, $this->rootURL."/_translations_/$mod.js");
 567             }
 568             return $files;
 569         }
 570         // works out if stuff has been updated..
 571         // technically the non-dev version should output compiled only?!!?
 572
 573         while (false !== ($f = readdir($dh))) {
 574            // var_dump($f);
 575             if (!preg_match('/\.js$/', $f)) {
 576                 continue;
 577             }
 578             // got the 'module file..'
 579
 580             $maxtime = max(filemtime($dir . '/'. $f), $maxtime);
 581             $files[] = $path . $f;
 582         }
 583         if (empty($files)) {
 584             return $files;
 585         }
 586        // var_dump(array($maxtime , $ctime));
 587         //if ($maxtime > $ctime) {
 588             $lsort = create_function('$a,$b','return strlen($a) > strlen($b) ? 1 : -1;');
 589             usort($files, $lsort);
 590            // if (file_exists($lfile)) {
 591            //     array_unshift($files, $this->rootURL."/_translations_/$mod.js");
 592             //}
 593             //var_dump($files);
 594             return $files;
 595        // }
 596
 597     }
 598
 599
 600
 601     /**
 602      * ---------------- Logging ---------------
 603      */
 604
 605
 606
 607
 608
 609     function addEvent($act, $obj = false, $remarks = '') {
 610         $au = $this->getAuthUser();
 611         $e = DB_DataObject::factory('Events');
 612
 613         if (is_a($e, 'PEAR_Error')) {
 614             return; // no event table!
 615         }
 616         $e->person_name = $au ? $au->name : '';
 617         $e->person_id = $au ? $au->id : '';
 618         $e->event_when = date('Y-m-d H:i:s');
 619         $e->ipaddr = isset($_SERVER["REMOTE_ADDR"]) ? $_SERVER["REMOTE_ADDR"] : 'cli';
 620         $e->action = $act;
 621         $e->on_table = $obj ? $obj->tableName() : '';
 622
 623         $pk = $obj ? $obj->keys()  : false;
 624
 625         $e->on_id  = $obj && $pk ? $obj->{$pk[0]}: 0;
 626         $e->remarks = $remarks;
 627         $e->insert();
 628
 629     }
 630
 631
 632
 633
 634 }