Source/carbon/libraries/Loader.php

   1 <?php
   2 /*------------------------------------------------------------
   3 *  CarbonPHP framework (C) Tom Bell
   4 *  http://tombell.org.uk
   5 *------------------------------------------------------------*/
   6
   7 if (!defined('CARBON_PATH'))
   8 {
   9         exit('Direct script access is not allowed.');
  10 }
  11
  12 class Carbon_Loader
  13 {
  14         private $loader_ob_level;
  15         private $loader_cached_vars = array();
  16         private $loader_classes = array();
  17         private $loader_models = array();
  18         private $loader_utilities = array();
  19         private $loader_varmap = array();
  20         private $loader_view_path = '';
  21
  22         public function __construct()
  23         {
  24                 $this->loader_view_path = APP_PATH . 'views/';
  25                 $this->loader_ob_level = ob_get_level();
  26
  27                 log_message('debug', 'Loader class initialised.');
  28         }
  29
  30         public function library($library = '', $params = null)
  31         {
  32                 if ($library == '')
  33                 {
  34                         return false;
  35                 }
  36
  37                 if (is_array($library))
  38                 {
  39                         foreach ($library as $class_name)
  40                         {
  41                                 $this->c_load_class($class_name, $params);
  42                         }
  43                 }
  44                 else
  45                 {
  46                         $this->c_load_class($library, $params);
  47                 }
  48
  49                 $this->c_assign_to_models();
  50         }
  51
  52         public function model($model, $name = '', $db_conn = false)
  53         {
  54                 if ($model == '')
  55                 {
  56                         return false;
  57                 }
  58
  59                 if (strpos($model, '/') === false)
  60                 {
  61                         $path = '';
  62                 }
  63                 else
  64                 {
  65                         $x = explode('/', $model);
  66                         $model = end($x);
  67                         unset($x[count($x) - 1]);
  68                         $path = implode('/', $x) . '/';
  69                 }
  70
  71                 if ($name == '')
  72                 {
  73                         $name = $model;
  74                 }
  75
  76                 if (in_array($name, $this->loader_models, true))
  77                 {
  78                         return true;
  79                 }
  80
  81                 $carbon = get_instance();
  82
  83                 if (isset($carbon->$name))
  84                 {
  85                         display_error('The model name you are trying to load shared a name with a resource already in use: ' . $name);
  86                 }
  87
  88                 $model = strtolower($model);
  89
  90                 if (!file_exists(APP_PATH . 'models/' . $path . $model . FILE_EXT))
  91                 {
  92                         display_error('Unable to load the model file you have specified: ' . $model);
  93                 }
  94
  95                 if ($db_conn !== false && !class_exists('Carbon_Database'))
  96                 {
  97                         if ($db_conn == true)
  98                         {
  99                                 $db_conn = '';
 100                         }
 101
 102                         $carbon->load->database($db_conn, false, true);
 103                 }
 104
 105                 if (!class_exists('Model'))
 106                 {
 107                         require_once(CARBON_PATH . 'libraries/Model' . FILE_EXT);
 108                 }
 109
 110                 require_once(APP_PATH . 'models/' . $path . $model . FILE_EXT);
 111
 112                 $model = ucfirst($model);
 113
 114                 $carbon->$name = new $model();
 115
 116                 $carbon->$name->assign_libraries();
 117                 $this->loader_models[] = $name;
 118         }
 119
 120         public function database($params = '', $return = false, $active_record = false)
 121         {
 122                 if (class_exists('Carbon_Database') && $return == false && $active_record == false)
 123                 {
 124                         return false;
 125                 }
 126
 127                 require_once(CARBON_PATH . 'database/Database' . FILE_EXT);
 128
 129                 if ($return === true)
 130                 {
 131                         return Database($params, $active_record);
 132                 }
 133
 134                 $carbon = get_instance();
 135                 $carbon->db = '';
 136                 $carbon->db = Database($params, $active_record);
 137                 $this->c_assign_to_models();
 138         }
 139
 140         public function dbutils()
 141         {
 142                 if (!class_exists('Carbon_Database'))
 143                 {
 144                         $this->database();
 145                 }
 146
 147                 $carbon = get_instance();
 148
 149                 require_once(CARBON_PATH . 'database/Database_utility' . FILE_EXT);
 150                 require_once(CARBON_PATH . 'database/drivers/' . $carbon->db->dbdriver . '/' . $carbon->db->dbdriver . '_utility' . FILE_EXT);
 151
 152                 $class = 'Carbon_Database_' . $carbon->db->dbdriver . '_utility';
 153
 154                 $carbon->dbutils = new $class();
 155
 156                 $carbon->load->c_assign_to_models();
 157         }
 158
 159         public function view($view, $vars = array(), $return = false)
 160         {
 161                 return $this->c_load(array('view' => $view, 'vars' => $this->c_object_to_array($vars), 'return' => $return));
 162         }
 163
 164         public function file($path, $return = false)
 165         {
 166                 return $this->c_load(array('path' => $path, 'return' => $return));
 167         }
 168
 169         public function vars($vars = array())
 170         {
 171                 $vars = $this->c_object_to_array($vars);
 172
 173                 if (is_array($vars) && count($vars) > 0)
 174                 {
 175                         foreach ($vars as $key => $val)
 176                         {
 177                                 $this->loader_cached_vars[$key] = $val;
 178                         }
 179                 }
 180         }
 181
 182         public function utility($utilities = array())
 183         {
 184                 if (!is_array($utilities))
 185                 {
 186                         $utilities = array($utilities);
 187                 }
 188
 189                 foreach ($utilities as $utility)
 190                 {
 191                         $utility = strtolower(str_replace(FILE_EXT, '', str_replace('_utility', '', $utility)) . '_utility');
 192
 193                         if (isset($this->loader_utilities[$utility]))
 194                         {
 195                                 continue;
 196                         }
 197
 198                         if (file_exists(APP_PATH . 'utilities/' . $utility . FILE_EXT))
 199                         {
 200                                 include_once(APP_PATH . 'utilities/' . $utility . FILE_EXT);
 201                         }
 202                         else
 203                         {
 204                                 if (file_exists(CARBON_PATH . 'utilities/' . $utility . FILE_EXT))
 205                                 {
 206                                         include(CARBON_PATH . 'utilities/' . $utility . FILE_EXT);
 207                                 }
 208                                 else
 209                                 {
 210                                         display_error('Unable to load the utility file: utilities/' . $utility . FILE_EXT);
 211                                 }
 212                         }
 213
 214                         $this->loader_utilities[$utility] = true;
 215                 }
 216
 217                 log_message('debug', 'Utilities loaded: ' . implode(', ', $utilities));
 218         }
 219
 220         public function language($file = array(), $lang = '')
 221         {
 222                 $carbon = get_instance();
 223
 224                 if (!is_array($file))
 225                 {
 226                         $file = array($file);
 227                 }
 228
 229                 foreach ($file as $langfile)
 230                 {
 231                         $carbon->lang->load($langfile, $lang);
 232                 }
 233         }
 234
 235         public function scaffold_language($file = '', $lang = '', $return = false)
 236         {
 237                 $carbon = get_instance();
 238
 239                 return $carbon->lang->load($file, $lang, $return);
 240         }
 241
 242         public function config($file = '', $use_sections = false, $fail_gracefully = false)
 243         {
 244                 $carbon = get_instance();
 245                 $carbon->config->load($file, $use_sections, $fail_gracefully);
 246         }
 247
 248         public function scaffolding($table = '')
 249         {
 250                 if ($table === false)
 251                 {
 252                         display_error('You must include the name of the table you would like to access when you initialise scaffolding');
 253                 }
 254
 255                 $carbon = get_instance();
 256                 $carbon->set_scaffolding(true);
 257                 $carbon->set_scaff_table($table);
 258         }
 259
 260         private function c_load($data)
 261         {
 262
 263                 $view = $vars = $path = $return = '';
 264
 265                 foreach (array('view', 'vars', 'path', 'return') as $val)
 266                 {
 267                         $$val = (!isset($data[$val])) ? false : $data[$val];
 268                 }
 269
 270                 if ($path == '')
 271                 {
 272                         $ext = pathinfo($view, PATHINFO_EXTENSION);
 273                         $file = ($ext =='') ? $view . FILE_EXT : $view;
 274                         $path = $this->loader_view_path . $file;
 275                 }
 276                 else
 277                 {
 278                         $x = explode('/', $path);
 279                         $file = end($x);
 280                 }
 281
 282                 if (!file_exists($path))
 283                 {
 284                         display_error('Unable to load the specified file: ' . $file);
 285                 }
 286
 287                 $carbon = get_instance();
 288
 289                 foreach (get_object_vars($carbon) as $key => $var)
 290                 {
 291                         $this->$key = $carbon->$key;
 292                 }
 293
 294                 if (is_array($vars))
 295                 {
 296                         $this->loader_cached_vars = array_merge($this->loader_cached_vars, $vars);
 297                 }
 298
 299                 extract($this->loader_cached_vars);
 300
 301                 ob_start();
 302
 303                 if ((bool) @ini_get('short_open_tag') === false && get_config_item('short_tag_rewrite') == true)
 304                 {
 305                         echo eval('?>' . preg_replace("/;*\s*\?>/", "; ?>", str_replace('<?=', '<?php echo ', file_get_contents($path))) . '<?php ');
 306                 }
 307                 else
 308                 {
 309                         include($path);
 310                 }
 311
 312                 log_message('debug', 'Loaded file: ' . $path);
 313
 314                 if ($return === true)
 315                 {
 316                         $buffer = ob_get_contents();
 317                         @ob_end_clean();
 318
 319                         return $buffer;
 320                 }
 321
 322                 if (ob_get_level() > $this->loader_ob_level + 1)
 323                 {
 324                         ob_end_flush();
 325                 }
 326                 else
 327                 {
 328                         global $output;
 329                         $output->set_final_output(ob_get_contents());
 330                         @ob_end_clean();
 331                 }
 332         }
 333
 334         private function c_load_class($class_name, $params = null)
 335         {
 336                 $class_name = str_replace(FILE_EXT, '', $class_name);
 337
 338                 foreach (array(ucfirst($class_name), strtolower($class_name)) as $class)
 339                 {
 340                         $subclass = APP_PATH . 'libraries/' . get_config_value('subclass_prefix') . $class . FILE_EXT;
 341
 342                         if (file_exists($subclass))
 343                         {
 344                                 $base_class = CARBON_PATH . 'libraries/' . ucfirst($class) . FILE_EXT;
 345
 346                                 if (!file_exists($base_class))
 347                                 {
 348                                         log_message('error', 'Unable to load the requested class file: ' . $class);
 349                                         display_error('Unable to load the requested class file: ' . $class);
 350
 351                                         return false;
 352                                 }
 353
 354                                 if (in_array($subclass, $this->loader_classes))
 355                                 {
 356                                         $is_duplicated = true;
 357                                         log_message('debug', 'Class already loaded, ignoring second load attempt: ' . $class);
 358
 359                                         return false;
 360                                 }
 361
 362                                 include($base_class);
 363                                 include($subclass);
 364
 365                                 $this->loader_classes[] = $subclass;
 366
 367                                 return $this->c_init_class($class, get_config_item('subclass_prefix'), $params);
 368                         }
 369
 370                         $is_duplicated = false;
 371
 372                         for ($i = 1; $i < 3; $i++)
 373                         {
 374                                 $path = ($i % 2) ? APP_PATH : CARBON_PATH;
 375                                 $file_path = $path . 'libraries/' . $class . FILE_EXT;
 376
 377                                 if (!file_exists($file_path))
 378                                 {
 379                                         continue;
 380                                 }
 381
 382                                 if (in_array($file_path, $this->loader_classes))
 383                                 {
 384                                         $is_duplicated = true;
 385                                         log_message('debug', 'Class already loaded, ignoring second load attempt: ' . $class);
 386
 387                                         return false;
 388                                 }
 389
 390                                 include($file_path);
 391
 392                                 $this->loader_classes[] = $file_path;
 393
 394                                 return $this->c_init_class($class, '', $params);
 395                         }
 396                 }
 397
 398                 if ($is_duplicated == false)
 399                 {
 400                         log_message('error', 'Unable to load the requested class file: ' . $class);
 401                         display_error('Unable to load the requested class file: ' . $class);
 402
 403                         return false;
 404                 }
 405         }
 406
 407         private function c_init_class($class, $prefix = '', $config = false)
 408         {
 409                 if ($config === null)
 410                 {
 411                         $config = null;
 412
 413                         if (file_exists(APP_PATH . 'config/' . $class . FILE_EXT))
 414                         {
 415                                 include(APP_PATH . 'config/' . $class . FILE_EXT);
 416                         }
 417                 }
 418
 419                 if ($prefix == '')
 420                 {
 421                         $name = (class_exists('Carbon_' . $class)) ? 'Carbon_' . $class : $class;
 422                 }
 423                 else
 424                 {
 425                         $name = $prefix . $class;
 426                 }
 427
 428                 $class = strtolower($class);
 429                 $classvar = (!isset($this->loader_varmap[$class])) ? $class : $this->loader_varmap[$class];
 430
 431                 $carbon = get_instance();
 432
 433                 if ($config !== null)
 434                 {
 435                         $carbon->$classvar = new $name($config);
 436                 }
 437                 else
 438                 {
 439                         $carbon->$classvar = new $name;
 440                 }
 441         }
 442
 443         public function autoloader()
 444         {
 445                 include(APP_PATH . 'config/autoload' . FILE_EXT);
 446
 447                 if (!isset($autoload))
 448                 {
 449                         return false;
 450                 }
 451
 452                 if (count($autoload['config']) > 0)
 453                 {
 454                         $carbon = get_instance();
 455
 456                         foreach ($autoload['config'] as $key => $value)
 457                         {
 458                                 $carbon->config->load($value);
 459                         }
 460                 }
 461
 462                 foreach (array('utility', 'language') as $type)
 463                 {
 464                         if (isset($autoload[$type]) && count($autoload[$type]) > 0)
 465                         {
 466                                 $this->$type($autoload[$type]);
 467                         }
 468                 }
 469
 470                 if (isset($autoload['libraries']) && count($autoload['libraries']) > 0)
 471                 {
 472                         if (in_array('database', $autoload['libraries']))
 473                         {
 474                                 $this->database();
 475                                 $autoload['libraries'] = array_diff($autoload['libraries'], array('database'));
 476                         }
 477
 478                         if (in_array('model', $autoload['libraries']))
 479                         {
 480                                 $this->model();
 481                                 $autoload['libraries'] = array_diff($autoload['libraries'], array('model'));
 482                         }
 483
 484                         if (in_array('scaffolding', $autoload['libraries']))
 485                         {
 486                                 $this->scaffolding();
 487                                 $autoload['libraries'] = array_diff($autoload['libraries'], array('scaffolding'));
 488                         }
 489
 490                         foreach ($autoload['libraries'] as $library)
 491                         {
 492                                 $this->library($library);
 493                         }
 494                 }
 495         }
 496
 497         public function set_view_path($view_path)
 498         {
 499                 $this->loader_view_path = $view_path;
 500         }
 501
 502         private function c_assign_to_models()
 503         {
 504                 if (count($this->loader_models) == 0)
 505                 {
 506                         return false;
 507                 }
 508
 509                 $carbon = get_instance();
 510
 511                 foreach ($this->loader_models as $model)
 512                 {
 513                         $carbon->$model->assign_libraries();
 514                 }
 515         }
 516
 517         private function c_object_to_array($object)
 518         {
 519                 return (is_object($object)) ? get_object_vars($object) : $object;
 520         }
 521 }
 522
 523 ?>