api.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Iris Studios Shared Object Framework [#]version[#]
   5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23 * Abstract Datamanger API
  24 * api.php
  25 *
  26 * @package      ISSO
  27 */
  28
  29 if (!defined('REQ_AUTO'))
  30 {
  31         /**
  32         * Auto-increasing value
  33         */
  34         define('REQ_AUTO', -1);
  35
  36         /**
  37         * Set by a cusotm set_*() function
  38         */
  39         define('REQ_SET', 2);
  40
  41         /**
  42         * Index for cleaning type
  43         */
  44         define('F_TYPE', 0);
  45
  46         /**
  47         * Index for requirement type
  48         */
  49         define('F_REQ', 1);
  50
  51         /**
  52         * Index for verification type
  53         */
  54         define('F_VERIFY', 2);
  55
  56         /**
  57         * Index for relation
  58         */
  59         define('F_RELATION', 3);
  60
  61         /**
  62         * Relation index for file name, relative to ISSO->apppath
  63         */
  64         define('F_RELATION_FILE', 0);
  65
  66         /**
  67         * Relation index for class name
  68         */
  69         define('F_RELATION_CLASS', 1);
  70
  71         /**
  72         * Relation index for field-link alternate name
  73         */
  74         define('F_RELATION_ALTFIELD', 2);
  75 }
  76
  77 /**
  78 * Abstract API
  79 *
  80 * Abstract class that is used as an API base for most common database interaction
  81 * schemes. Creates a simple structure that holds data and can update, delete, and
  82 * insert.
  83 *
  84 * @author               Iris Studios, Inc.
  85 * @copyright    Copyright ©2002 - [#]year[#], Iris Studios, Inc.
  86 * @version              $Revision$
  87 * @package              ISSO
  88 *
  89 */
  90 class API
  91 {
  92         /**
  93         * Registry object
  94         * @var  object
  95         * @access       protected
  96         */
  97         var $registry = null;
  98
  99         /**
 100         * Fields: used for verification and sanitization
 101         * NAME => array(TYPE, REQUIRED, VERIFY METHOD (:self for self-named method), RELATION => array(FILE, CLASS IN FILE, ALTERNATE FIELD NAME))
 102         * @var  array
 103         * @access       protected
 104         */
 105         var $fields = array();
 106
 107         /**
 108         * Values array: sanitized and verified field values
 109         * @var  array
 110         * @access       public
 111         */
 112         var $values = array();
 113
 114         /**
 115         * Fields that were manually set with set(), not by using set_existing()
 116         * @var  array
 117         * @access       private
 118         */
 119         var $setfields = array();
 120
 121         /**
 122         * An array of all of the processed relations on an object
 123         * @var  array
 124         * @access       public
 125         */
 126         var $relations = array();
 127
 128         /**
 129         * WHERE condition
 130         * @var  string
 131         * @access       private
 132         */
 133         var $condition = '';
 134
 135         /**
 136         * The object table row; a fetched row that represents this instance
 137         * @var  array
 138         * @access       public
 139         */
 140         var $objdata = array();
 141
 142         /**
 143         * Insert ID from the insert() command
 144         * @var  integer
 145         * @access       public
 146         */
 147         var $insertid = 0;
 148
 149         /**
 150         * Pre- and post-action method stoppers
 151         * @var  array
 152         * @access       public
 153         */
 154         var $norunners = array();
 155
 156         /**
 157         * The relations to execute on
 158         * @var  array
 159         * @access       public
 160         */
 161         var $dorelations = array('fetch');
 162
 163         /**
 164         * Error list that has been generated
 165         * @var  array
 166         * @access       private
 167         */
 168         var $errors = array();
 169
 170         // ###################################################################
 171         /**
 172         * Constructor: cannot instantiate class directly
 173         */
 174         function __construct(&$registry)
 175         {
 176                 if (!is_subclass_of($this, 'API'))
 177                 {
 178                         trigger_error('Cannot instantiate the API module directly', E_USER_ERROR);
 179                 }
 180
 181                 if (!is_object($registry))
 182                 {
 183                         trigger_error('The passed registry is not an object', E_USER_ERROR);
 184                 }
 185
 186                 $this->registry =& $registry;
 187         }
 188
 189         // ###################################################################
 190         /**
 191         * (PHP 4) Constructor
 192         */
 193         function API(&$registry)
 194         {
 195                 $this->__construct($registry);
 196         }
 197
 198         // ###################################################################
 199         /**
 200         * Constructs an error for the error handler to receive
 201         *
 202         * @access       protected
 203         *
 204         * @param        string  Error message
 205         */
 206         function error($message)
 207         {
 208                 $this->errors[] = $message;
 209
 210                 // we want to explicitly specify silence
 211                 if (APIError() == 'silent')
 212                 {
 213                         return;
 214                 }
 215
 216                 if (!is_callable(APIError()))
 217                 {
 218                         trigger_error('No APIError() handler has been set', E_USER_WARNING);
 219                 }
 220
 221                 call_user_func(APIError(), $message);
 222         }
 223
 224         // ###################################################################
 225         /**
 226         * Returns the error list. This is because we don't want people mucking
 227         * with the error system. It will return an empty array if there are
 228         * no errors.
 229         *
 230         * @access       public
 231         *
 232         * @return       array   Array of errors
 233         */
 234         function check_errors()
 235         {
 236                 if (sizeof($this->errors) < 1)
 237                 {
 238                         return array();
 239                 }
 240
 241                 return $this->errors;
 242         }
 243
 244         // ###################################################################
 245         /**
 246         * Sets a value, sanitizes it, and verifies it
 247         *
 248         * @access       public
 249         *
 250         * @param        string  Field name
 251         * @param        mixed   Value
 252         * @param        bool    Do clean?
 253         * @param        bool    Do verify?
 254         */
 255         function set($field, $value, $doclean = true, $doverify = true)
 256         {
 257                 if (!isset($this->fields["$field"]))
 258                 {
 259                         trigger_error('Field `' . $field . '` is not valid', E_USER_WARNING);
 260                         return;
 261                 }
 262
 263                 $this->values["$field"] = ($doclean ? $this->registry->clean($value, $this->fields["$field"][F_TYPE]) : $value);
 264
 265                 $this->setfields["$field"] = $field;
 266
 267                 if (isset($this->fields["$field"][F_VERIFY]) AND $doverify)
 268                 {
 269                         if ($this->fields["$field"][F_VERIFY] == ':self')
 270                         {
 271                                 $verify = $this->{"verify_$field"}($field);
 272                         }
 273                         else
 274                         {
 275                                 $verify = $this->{$this->fields["$field"][F_VERIFY]}($field);
 276                         }
 277
 278                         if (!$verify)
 279                         {
 280                                 $this->error(sprintf($this->registry->modules['localize']->string('Validation of %1$s failed'), $field));
 281                         }
 282                 }
 283         }
 284
 285         // ###################################################################
 286         /**
 287         * Sets the condition to use in the WHERE clause; if not passed, then
 288         * it calculates it from the REQ_AUTO field
 289         *
 290         * @access       public
 291         *
 292         * @param        string  WHERE conditional bit
 293         */
 294         function set_condition($condition = '')
 295         {
 296                 if ($condition != '')
 297                 {
 298                         $this->condition = $condition;
 299                 }
 300                 else
 301                 {
 302                         foreach ($this->fields AS $name => $options)
 303                         {
 304                                 if ($options[F_REQ] == REQ_AUTO)
 305                                 {
 306                                         if (!$this->values["$name"])
 307                                         {
 308                                                 trigger_error('Cannot determine condition from the REQ_AUTO field because it is not set', E_USER_WARNING);
 309                                                 continue;
 310                                         }
 311
 312                                         $this->condition = "$name = " . $this->prepare_field_for_sql($name);
 313                                 }
 314                         }
 315
 316                         if ($this->condition == '')
 317                         {
 318                                 trigger_error('No REQ_AUTO fields are present and therefore the condition cannot be created', E_USER_WARNING);
 319                         }
 320                 }
 321         }
 322
 323         // ###################################################################
 324         /**
 325         * Sets existing data into $values where it's not already present
 326         *
 327         * @access       public
 328         */
 329         function set_existing()
 330         {
 331                 static $run;
 332                 if ($run)
 333                 {
 334                         return;
 335                 }
 336
 337                 $this->fetch();
 338
 339                 foreach ($this->objdata AS $field => $value)
 340                 {
 341                         if (!isset($this->values["$field"]))
 342                         {
 343                                 $this->values["$field"] = $value;
 344                         }
 345                 }
 346
 347                 $run = true;
 348         }
 349
 350         // ###################################################################
 351         /**
 352         * Fetches a record based on the condition
 353         *
 354         * @access       public
 355         */
 356         function fetch()
 357         {
 358                 if ($this->condition == '')
 359                 {
 360                         trigger_error('Condition is empty: cannot fetch', E_USER_ERROR);
 361                 }
 362
 363                 $this->run_action_method('pre_fetch');
 364
 365                 $result = $this->registry->modules[ISSO_DB_LAYER]->query_first("SELECT * FROM {$this->prefix}{$this->table} WHERE {$this->condition}");
 366                 if (!$result)
 367                 {
 368                         $this->error($this->registry->modules['localize']->string('No records were returned'));
 369                         return;
 370                 }
 371
 372                 $this->run_action_method('post_fetch');
 373
 374                 $this->objdata = $result;
 375
 376                 $this->call_relations('fetch');
 377         }
 378
 379         // ###################################################################
 380         /**
 381         * Inserts a record in the database
 382         *
 383         * @access       public
 384         */
 385         function insert()
 386         {
 387                 $this->verify();
 388
 389                 $this->run_action_method('pre_insert');
 390
 391                 foreach ($this->setfields AS $field)
 392                 {
 393                         $fields[] = $field;
 394                         $values[] = $this->prepare_field_for_sql($field);
 395                 }
 396
 397                 $this->registry->modules[ISSO_DB_LAYER]->query("INSERT INTO {$this->prefix}{$this->table} (" . implode(',', $fields) . ") VALUES (" . implode(',', $values) . ")");
 398
 399                 if (strcasecmp(ISSO_DB_LAYER, 'DB_PostgreSQL') == 0)
 400                 {
 401                         foreach ($this->fields AS $field => $info)
 402                         {
 403                                 if ($info[F_REQ] == REQ_AUTO)
 404                                 {
 405                                         $autofield = $field;
 406                                         break;
 407                                 }
 408                         }
 409
 410                         $this->insertid = $this->registry->modules[ISSO_DB_LAYER]->insert_id($this->prefix . $this->table, $autofield);
 411                 }
 412                 else
 413                 {
 414                         $this->insertid = $this->registry->modules[ISSO_DB_LAYER]->insert_id();
 415                 }
 416
 417                 $this->run_action_method('post_insert');
 418         }
 419
 420         // ###################################################################
 421         /**
 422         * Updates a record in the database using the data in $vaues
 423         *
 424         * @access       public
 425         */
 426         function update()
 427         {
 428                 if ($this->condition == '')
 429                 {
 430                         trigger_error('Condition is empty: cannot fetch', E_USER_ERROR);
 431                 }
 432
 433                 $this->run_action_method('pre_update');
 434
 435                 foreach ($this->setfields AS $field)
 436                 {
 437                         $updates[] = "$field = " . $this->prepare_field_for_sql($field);
 438                 }
 439                 $updates = implode(', ', $updates);
 440
 441                 $this->registry->modules[ISSO_DB_LAYER]->query("UPDATE {$this->prefix}{$this->table} SET $updates WHERE {$this->condition}");
 442
 443                 $this->run_action_method('post_update');
 444         }
 445
 446         // ###################################################################
 447         /**
 448         * Deletes a record
 449         *
 450         * @access       public
 451         */
 452         function delete()
 453         {
 454                 if ($this->condition == '')
 455                 {
 456                         trigger_error('Condition is empty: cannot fetch', E_USER_ERROR);
 457                 }
 458
 459                 $this->set_existing();
 460
 461                 $this->run_action_method('pre_delete');
 462
 463                 $this->registry->modules[ISSO_DB_LAYER]->query("DELETE FROM {$this->prefix}{$this->table} WHERE {$this->condition}");
 464
 465                 $this->run_action_method('post_delete');
 466         }
 467
 468         // ###################################################################
 469         /**
 470         * Verifies that all required fields are set
 471         *
 472         * @access       private
 473         */
 474         function verify()
 475         {
 476                 foreach ($this->fields AS $name => $options)
 477                 {
 478                         if ($options[F_REQ] == REQ_YES)
 479                         {
 480                                 if (!isset($this->values["$name"]))
 481                                 {
 482                                         $this->error(sprintf($this->registry->modules['localize']->string('Required field %1$s was not set'), $name));
 483                                 }
 484                         }
 485                         else if ($options[F_REQ] == REQ_SET)
 486                         {
 487                                 $this->{"set_$name"}();
 488                         }
 489                 }
 490         }
 491
 492         // ###################################################################
 493         /**
 494         * Runs a pre- or post-action method for database commands
 495         *
 496         * @access       private
 497         *
 498         * @param        string  Action to run
 499         */
 500         function run_action_method($method)
 501         {
 502                 if (in_array($method, $this->norunners))
 503                 {
 504                         return;
 505                 }
 506
 507                 $actmethod = (method_exists($this, $method) ? $this->$method() : '');
 508         }
 509
 510         // ###################################################################
 511         /**
 512         * Determines if it's safe to run a relation; if so, it will return
 513         * the WHERE SQL clause
 514         *
 515         * @access       public
 516         *
 517         * @param        string  Field name
 518         * @param        string  Operation to run
 519         */
 520         function call_relations($method)
 521         {
 522                 if (!in_array($method, $this->dorelations))
 523                 {
 524                         return;
 525                 }
 526
 527                 foreach ($this->fields AS $field => $info)
 528                 {
 529                         $value = (isset($this->values["$field"]) ? $this->values["$field"] : $this->objdata["$field"]);
 530                         if ($value == null OR !is_array($info[F_RELATION]))
 531                         {
 532                                 continue;
 533                         }
 534
 535                         if (!file_exists($this->registry->get('apppath') . $info[F_RELATION][F_RELATION_FILE]))
 536                         {
 537                                 trigger_error("Could not load the relation file for field '$field'");
 538                         }
 539
 540                         require_once($this->registry->get('apppath') . $info[F_RELATION][F_RELATION_FILE]);
 541
 542                         $this->relations["$field"] = new $info[F_RELATION][F_RELATION_CLASS]($this->registry);
 543                         $this->relations["$field"]->set(($info[F_RELATION][F_RELATION_ALTFIELD] ? $info[F_RELATION][F_RELATION_ALTFIELD] : $field), $value);
 544                         $this->relations["$field"]->set_condition();
 545                         $this->relations["$field"]->$method();
 546                 }
 547         }
 548
 549         // ###################################################################
 550         /**
 551         * Prepares a value for use in a SQL query; it encases and escapes
 552         * strings and string-like values
 553         *
 554         * @access       private
 555         *
 556         * @param        string  Field name
 557         *
 558         * @return       string  Prepared value entry
 559         */
 560         function prepare_field_for_sql($name)
 561         {
 562                 $type = $this->fields["$name"][F_TYPE];
 563
 564                 if ($type == TYPE_NOCLEAN OR $type == TYPE_STR OR $type == TYPE_STRUN)
 565                 {
 566                         return "'" . $this->registry->escape($this->values["$name"]) . "'";
 567                 }
 568                 else if ($type == TYPE_BOOL)
 569                 {
 570                         return ($this->values["$name"] == true ? 'TRUE' : 'FALSE');
 571                 }
 572                 else
 573                 {
 574                         return $this->values["$name"];
 575                 }
 576         }
 577
 578         // ###################################################################
 579         /**
 580         * Verify field: not a zero value
 581         *
 582         * @access       protected
 583         */
 584         function verify_nozero($field)
 585         {
 586                 if ($this->values["$field"] == 0)
 587                 {
 588                         return false;
 589                 }
 590
 591                 return true;
 592         }
 593
 594         // ###################################################################
 595         /**
 596         * Verify field: not empty
 597         *
 598         * @access       protected
 599         */
 600         function verify_noempty($field)
 601         {
 602                 if (empty($this->values["$field"]))
 603                 {
 604                         return false;
 605                 }
 606
 607                 return true;
 608         }
 609 }
 610
 611 // ###################################################################
 612 /**
 613 * Setter and getter method for the API error reporting system. Passing
 614 * a name will cause the set, no arguments will cause the get.
 615 *
 616 * @access       public
 617 *
 618 * @param        mixed   Method name in callable form
 619 *
 620 * @return       mixed   Method name in callable form
 621 */
 622 function APIError($new = null)
 623 {
 624         static $caller, $prev;
 625
 626         if ($new === -1)
 627         {
 628                 $caller = $prev;
 629         }
 630         else if ($new !== null)
 631         {
 632                 $prev = $caller;
 633                 $caller = $new;
 634         }
 635
 636         return $caller;
 637 }
 638
 639 /*=====================================================================*\
 640 || ###################################################################
 641 || # $HeadURL$
 642 || # $Id$
 643 || ###################################################################
 644 \*=====================================================================*/
 645 ?>