2010-02-17 13:54:36 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Symfony\Foundation;
|
|
|
|
|
2010-04-07 01:51:29 +01:00
|
|
|
use Symfony\Components\DependencyInjection\ContainerInterface;
|
|
|
|
use Symfony\Components\DependencyInjection\Builder;
|
|
|
|
use Symfony\Components\DependencyInjection\BuilderConfiguration;
|
|
|
|
use Symfony\Components\DependencyInjection\Dumper\PhpDumper;
|
|
|
|
use Symfony\Components\DependencyInjection\FileResource;
|
2010-05-06 11:04:50 +01:00
|
|
|
use Symfony\Components\HttpKernel\Request;
|
|
|
|
use Symfony\Components\HttpKernel\HttpKernelInterface;
|
2010-04-07 01:51:29 +01:00
|
|
|
|
2010-02-17 13:54:36 +00:00
|
|
|
/*
|
2010-04-07 01:51:29 +01:00
|
|
|
* This file is part of the Symfony package.
|
2010-02-17 13:54:36 +00:00
|
|
|
*
|
|
|
|
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
|
|
|
*
|
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The Kernel is the heart of the Symfony system. It manages an environment
|
|
|
|
* that can host bundles.
|
|
|
|
*
|
2010-04-07 01:51:29 +01:00
|
|
|
* @package Symfony
|
|
|
|
* @subpackage Foundation
|
|
|
|
* @author Fabien Potencier <fabien.potencier@symfony-project.org>
|
2010-02-17 13:54:36 +00:00
|
|
|
*/
|
2010-05-06 11:04:50 +01:00
|
|
|
abstract class Kernel implements HttpKernelInterface, \Serializable
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
protected $bundles;
|
|
|
|
protected $bundleDirs;
|
|
|
|
protected $container;
|
|
|
|
protected $rootDir;
|
|
|
|
protected $environment;
|
|
|
|
protected $debug;
|
|
|
|
protected $booted;
|
|
|
|
protected $name;
|
|
|
|
protected $startTime;
|
|
|
|
protected $request;
|
|
|
|
|
|
|
|
const VERSION = '2.0.0-DEV';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
*
|
|
|
|
* @param string $environment The environment
|
|
|
|
* @param Boolean $debug Whether to enable debugging or not
|
|
|
|
*/
|
|
|
|
public function __construct($environment, $debug)
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->environment = $environment;
|
|
|
|
$this->debug = (Boolean) $debug;
|
|
|
|
$this->booted = false;
|
|
|
|
$this->rootDir = realpath($this->registerRootDir());
|
|
|
|
$this->name = basename($this->rootDir);
|
2010-05-03 08:54:17 +01:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
if ($this->debug)
|
|
|
|
{
|
|
|
|
ini_set('display_errors', 1);
|
|
|
|
error_reporting(-1);
|
|
|
|
|
|
|
|
$this->startTime = microtime(true);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
ini_set('display_errors', 0);
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
abstract public function registerRootDir();
|
|
|
|
|
|
|
|
abstract public function registerBundles();
|
|
|
|
|
|
|
|
abstract public function registerBundleDirs();
|
|
|
|
|
|
|
|
abstract public function registerContainerConfiguration();
|
|
|
|
|
|
|
|
abstract public function registerRoutes();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks whether the current kernel has been booted or not.
|
|
|
|
*
|
|
|
|
* @return boolean $booted
|
|
|
|
*/
|
|
|
|
public function isBooted()
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->booted;
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Boots the current kernel.
|
|
|
|
*
|
|
|
|
* This method boots the bundles, which MUST set
|
|
|
|
* the DI container.
|
|
|
|
*
|
|
|
|
* @return Kernel The current Kernel instance
|
|
|
|
*
|
|
|
|
* @throws \LogicException When the Kernel is already booted
|
|
|
|
*/
|
|
|
|
public function boot()
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
if (true === $this->booted)
|
|
|
|
{
|
|
|
|
throw new \LogicException('The kernel is already booted.');
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->bundles = $this->registerBundles();
|
|
|
|
$this->bundleDirs = $this->registerBundleDirs();
|
2010-05-03 08:54:17 +01:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
// initialize the container
|
|
|
|
$this->container = $this->initializeContainer();
|
|
|
|
$this->container->setService('kernel', $this);
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
// boot bundles
|
|
|
|
foreach ($this->bundles as $bundle)
|
|
|
|
{
|
|
|
|
$bundle->boot($this->container);
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->booted = true;
|
|
|
|
|
|
|
|
return $this;
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Shutdowns the kernel.
|
|
|
|
*
|
|
|
|
* This method is mainly useful when doing functional testing.
|
|
|
|
*/
|
|
|
|
public function shutdown()
|
|
|
|
{
|
|
|
|
$this->booted = false;
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
foreach ($this->bundles as $bundle)
|
|
|
|
{
|
|
|
|
$bundle->shutdown($this->container);
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->container = null;
|
|
|
|
}
|
2010-04-19 08:05:11 +01:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Reboots the kernel.
|
|
|
|
*
|
|
|
|
* This method is mainly useful when doing functional testing.
|
|
|
|
*
|
|
|
|
* It is a shortcut for the call to shutdown() and boot().
|
|
|
|
*/
|
|
|
|
public function reboot()
|
2010-04-19 08:05:11 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->shutdown();
|
|
|
|
$this->boot();
|
2010-04-19 08:05:11 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Gets the Request instance associated with the main request.
|
|
|
|
*
|
|
|
|
* @return Request A Request instance
|
|
|
|
*/
|
|
|
|
public function getRequest()
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->request;
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Handles a request to convert it to a response by calling the Request Handler service.
|
|
|
|
*
|
|
|
|
* @param Request $request A Request instance
|
|
|
|
* @param Boolean $main Whether this is the main request or not
|
|
|
|
* @param Boolean $raw Whether to catch exceptions or not
|
|
|
|
*
|
|
|
|
* @return Response $response A Response instance
|
|
|
|
*
|
|
|
|
* @throws \Exception
|
|
|
|
*/
|
|
|
|
public function handle(Request $request = null, $main = true, $raw = false)
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
if (false === $this->booted)
|
|
|
|
{
|
|
|
|
$this->boot();
|
|
|
|
}
|
|
|
|
|
|
|
|
if (null === $request)
|
|
|
|
{
|
|
|
|
$request = $this->container->getRequestService();
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
$this->container->setService('request', $request);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (true === $main)
|
|
|
|
{
|
|
|
|
$this->request = $request;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (true === $raw)
|
|
|
|
{
|
|
|
|
return $this->container->getHttpKernelService()->handleRaw($request, $main);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
return $this->container->getHttpKernelService()->handle($request, $main);
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
public function getBundleDirs()
|
2010-04-08 10:12:58 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->bundleDirs;
|
2010-04-08 10:12:58 +01:00
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
public function getBundles()
|
2010-04-25 12:18:42 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->bundles;
|
2010-04-25 12:18:42 +01:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
public function getName()
|
2010-05-03 15:11:38 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->name;
|
2010-05-03 15:11:38 +01:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
public function getEnvironment()
|
2010-05-03 15:11:38 +01:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->environment;
|
2010-05-03 15:11:38 +01:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
public function isDebug()
|
2010-03-12 10:54:22 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->debug;
|
2010-03-12 10:54:22 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
public function getRootDir()
|
2010-02-22 10:57:59 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->rootDir;
|
2010-02-22 10:57:59 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
public function getContainer()
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->container;
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
public function getStartTime()
|
|
|
|
{
|
|
|
|
return $this->debug ? $this->startTime : -INF;
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
public function getCacheDir()
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->rootDir.'/cache/'.$this->environment;
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
public function getLogDir()
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $this->rootDir.'/logs';
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
protected function initializeContainer()
|
|
|
|
{
|
|
|
|
$class = $this->name.'ProjectContainer';
|
|
|
|
$location = $this->getCacheDir().'/'.$class;
|
|
|
|
$reload = $this->debug ? $this->needsReload($class, $location) : false;
|
|
|
|
|
|
|
|
if ($reload || !file_exists($location.'.php'))
|
|
|
|
{
|
|
|
|
$this->buildContainer($class, $location.'.php');
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
require_once $location.'.php';
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
return new $class();
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
public function getKernelParameters()
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$bundles = array();
|
|
|
|
foreach ($this->bundles as $bundle)
|
2010-02-24 03:12:55 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$bundles[] = get_class($bundle);
|
2010-02-24 03:12:55 +00:00
|
|
|
}
|
2010-05-06 12:25:53 +01:00
|
|
|
|
|
|
|
return array_merge(
|
|
|
|
array(
|
|
|
|
'kernel.root_dir' => $this->rootDir,
|
|
|
|
'kernel.environment' => $this->environment,
|
|
|
|
'kernel.debug' => $this->debug,
|
|
|
|
'kernel.name' => $this->name,
|
|
|
|
'kernel.cache_dir' => $this->getCacheDir(),
|
|
|
|
'kernel.logs_dir' => $this->getLogDir(),
|
|
|
|
'kernel.bundle_dirs' => $this->bundleDirs,
|
|
|
|
'kernel.bundles' => $bundles,
|
|
|
|
'kernel.charset' => 'UTF-8',
|
|
|
|
),
|
|
|
|
$this->getEnvParameters()
|
|
|
|
);
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
protected function getEnvParameters()
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$parameters = array();
|
|
|
|
foreach ($_SERVER as $key => $value)
|
|
|
|
{
|
|
|
|
if ('SYMFONY__' === substr($key, 0, 9))
|
|
|
|
{
|
|
|
|
$parameters[strtolower(str_replace('__', '.', substr($key, 9)))] = $value;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $parameters;
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
protected function needsReload($class, $location)
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
if (!file_exists($location.'.meta') || !file_exists($location.'.php'))
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
$meta = unserialize(file_get_contents($location.'.meta'));
|
|
|
|
$time = filemtime($location.'.php');
|
|
|
|
foreach ($meta as $resource)
|
|
|
|
{
|
|
|
|
if (!$resource->isUptodate($time))
|
|
|
|
{
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
protected function buildContainer($class, $file)
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$container = new Builder($this->getKernelParameters());
|
|
|
|
|
|
|
|
$configuration = new BuilderConfiguration();
|
|
|
|
foreach ($this->bundles as $bundle)
|
|
|
|
{
|
|
|
|
$configuration->merge($bundle->buildContainer($container));
|
|
|
|
}
|
|
|
|
$configuration->merge($this->registerContainerConfiguration());
|
|
|
|
$container->merge($configuration);
|
|
|
|
$this->optimizeContainer($container);
|
|
|
|
|
|
|
|
foreach (array('cache', 'logs') as $name)
|
|
|
|
{
|
|
|
|
$dir = $container->getParameter(sprintf('kernel.%s_dir', $name));
|
|
|
|
if (!is_dir($dir))
|
|
|
|
{
|
|
|
|
if (false === @mkdir($dir, 0777, true))
|
|
|
|
{
|
|
|
|
die(sprintf('Unable to create the %s directory (%s)', $name, dirname($dir)));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
elseif (!is_writable($dir))
|
|
|
|
{
|
|
|
|
die(sprintf('Unable to write in the %s directory (%s)', $name, $dir));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// cache the container
|
|
|
|
$dumper = new PhpDumper($container);
|
|
|
|
$content = $dumper->dump(array('class' => $class));
|
|
|
|
if (!$this->debug)
|
|
|
|
{
|
|
|
|
$content = self::stripComments($content);
|
|
|
|
}
|
|
|
|
$this->writeCacheFile($file, $content);
|
|
|
|
|
|
|
|
if ($this->debug)
|
|
|
|
{
|
|
|
|
// add the Kernel class hierarchy as resources
|
|
|
|
$parent = new \ReflectionObject($this);
|
|
|
|
$configuration->addResource(new FileResource($parent->getFileName()));
|
|
|
|
while ($parent = $parent->getParentClass())
|
|
|
|
{
|
|
|
|
$configuration->addResource(new FileResource($parent->getFileName()));
|
|
|
|
}
|
|
|
|
|
|
|
|
// save the resources
|
|
|
|
$this->writeCacheFile($this->getCacheDir().'/'.$class.'.meta', serialize($configuration->getResources()));
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
public function optimizeContainer(Builder $container)
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
// replace all classes with the real value
|
|
|
|
foreach ($container->getDefinitions() as $definition)
|
|
|
|
{
|
|
|
|
if (false !== strpos($class = $definition->getClass(), '%'))
|
|
|
|
{
|
|
|
|
$definition->setClass(Builder::resolveValue($class, $container->getParameters()));
|
|
|
|
unset($container[substr($class, 1, -1)]);
|
|
|
|
}
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
static public function stripComments($source)
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
if (!function_exists('token_get_all'))
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
return $source;
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
$ignore = array(T_COMMENT => true, T_DOC_COMMENT => true);
|
|
|
|
$output = '';
|
|
|
|
foreach (token_get_all($source) as $token)
|
|
|
|
{
|
|
|
|
// array
|
|
|
|
if (isset($token[1]))
|
|
|
|
{
|
|
|
|
// no action on comments
|
|
|
|
if (!isset($ignore[$token[0]]))
|
|
|
|
{
|
|
|
|
// anything else -> output "as is"
|
|
|
|
$output .= $token[1];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
// simple 1-character token
|
|
|
|
$output .= $token;
|
|
|
|
}
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
return $output;
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
protected function writeCacheFile($file, $content)
|
2010-02-17 13:54:36 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$tmpFile = tempnam(dirname($file), basename($file));
|
|
|
|
if (!$fp = @fopen($tmpFile, 'wb'))
|
|
|
|
{
|
|
|
|
die(sprintf('Failed to write cache file "%s".', $tmpFile));
|
|
|
|
}
|
|
|
|
@fwrite($fp, $content);
|
|
|
|
@fclose($fp);
|
2010-02-17 13:54:36 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
if ($content != file_get_contents($tmpFile))
|
|
|
|
{
|
|
|
|
die(sprintf('Failed to write cache file "%s" (cache corrupted).', $tmpFile));
|
|
|
|
}
|
2010-04-02 15:47:59 +01:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
@rename($tmpFile, $file);
|
|
|
|
chmod($file, 0644);
|
|
|
|
}
|
2010-04-02 15:47:59 +01:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
public function serialize()
|
|
|
|
{
|
|
|
|
return serialize(array($this->environment, $this->debug));
|
|
|
|
}
|
2010-04-02 15:47:59 +01:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
public function unserialize($data)
|
|
|
|
{
|
|
|
|
list($environment, $debug) = unserialize($data);
|
|
|
|
|
|
|
|
$this->__construct($environment, $debug);
|
|
|
|
}
|
2010-02-17 13:54:36 +00:00
|
|
|
}
|