123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273 |
- <?php
- namespace Elgg\Di;
- use Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage;
- use Symfony\Component\HttpFoundation\Session\Session as SymfonySession;
- /**
- * Provides common Elgg services.
- *
- * We extend the container because it allows us to document properties in the PhpDoc, which assists
- * IDEs to auto-complete properties and understand the types returned. Extension allows us to keep
- * the container generic.
- *
- * @property-read \Elgg\Database\AccessCollections $accessCollections
- * @property-read \ElggStaticVariableCache $accessCache
- * @property-read \Elgg\ActionsService $actions
- * @property-read \Elgg\Database\AdminNotices $adminNotices
- * @property-read \Elgg\Amd\Config $amdConfig
- * @property-read \Elgg\Database\Annotations $annotations
- * @property-read \ElggAutoP $autoP
- * @property-read \Elgg\AutoloadManager $autoloadManager
- * @property-read \ElggCrypto $crypto
- * @property-read \Elgg\Config $config
- * @property-read \Elgg\Database\ConfigTable $configTable
- * @property-read \Elgg\Context $context
- * @property-read \Elgg\Database\Datalist $datalist
- * @property-read \Elgg\Database $db
- * @property-read \Elgg\DeprecationService $deprecation
- * @property-read \Elgg\EntityPreloader $entityPreloader
- * @property-read \Elgg\Database\EntityTable $entityTable
- * @property-read \Elgg\EventsService $events
- * @property-read \Elgg\Assets\ExternalFiles $externalFiles
- * @property-read \Elgg\PluginHooksService $hooks
- * @property-read \Elgg\Http\Input $input
- * @property-read \Elgg\Logger $logger
- * @property-read \Elgg\Cache\MetadataCache $metadataCache
- * @property-read \Elgg\Database\MetadataTable $metadataTable
- * @property-read \Elgg\Database\MetastringsTable $metastringsTable
- * @property-read \Elgg\Notifications\NotificationsService $notifications
- * @property-read \Elgg\PasswordService $passwords
- * @property-read \Elgg\PersistentLoginService $persistentLogin
- * @property-read \Elgg\Database\Plugins $plugins
- * @property-read \Elgg\Database\PrivateSettingsTable $privateSettings
- * @property-read \Elgg\Database\QueryCounter $queryCounter
- * @property-read \Elgg\Http\Request $request
- * @property-read \Elgg\Database\RelationshipsTable $relationshipsTable
- * @property-read \Elgg\Router $router
- * @property-read \ElggSession $session
- * @property-read \Elgg\Cache\SimpleCache $simpleCache
- * @property-read \Elgg\Database\SiteSecret $siteSecret
- * @property-read \Elgg\Forms\StickyForms $stickyForms
- * @property-read \Elgg\Database\SubtypeTable $subtypeTable
- * @property-read \Elgg\Cache\SystemCache $systemCache
- * @property-read \Elgg\SystemMessagesService $systemMessages
- * @property-read \Elgg\I18n\Translator $translator
- * @property-read \Elgg\Database\UsersTable $usersTable
- * @property-read \Elgg\ViewsService $views
- * @property-read \Elgg\WidgetsService $widgets
- *
- * @package Elgg.Core
- * @access private
- */
- class ServiceProvider extends \Elgg\Di\DiContainer {
- /**
- * Constructor
- *
- * @param \Elgg\AutoloadManager $autoload_manager Class autoloader
- */
- public function __construct(\Elgg\AutoloadManager $autoload_manager) {
- $this->setValue('autoloadManager', $autoload_manager);
- $this->setFactory('accessCache', function(ServiceProvider $c) {
- return new \ElggStaticVariableCache('access');
- });
- $this->setFactory('accessCollections', function(ServiceProvider $c) {
- return new \Elgg\Database\AccessCollections($c->config->get('site_guid'));
- });
- $this->setClassName('actions', '\Elgg\ActionsService');
- $this->setClassName('adminNotices', '\Elgg\Database\AdminNotices');
- $this->setFactory('amdConfig', function(ServiceProvider $c) {
- $obj = new \Elgg\Amd\Config($c->hooks);
- $obj->setBaseUrl($c->simpleCache->getRoot() . "js/");
- return $obj;
- });
- $this->setClassName('annotations', '\Elgg\Database\Annotations');
- $this->setClassName('autoP', '\ElggAutoP');
- $this->setClassName('config', '\Elgg\Config');
- $this->setClassName('configTable', '\Elgg\Database\ConfigTable');
- $this->setClassName('context', '\Elgg\Context');
- $this->setClassName('crypto', '\ElggCrypto');
- $this->setFactory('datalist', function(ServiceProvider $c) {
- // TODO(ewinslow): Add back memcached support
- $db = $c->db;
- $dbprefix = $db->getTablePrefix();
- $pool = new \Elgg\Cache\MemoryPool();
- return new \Elgg\Database\Datalist($pool, $db, $c->logger, "{$dbprefix}datalists");
- });
- $this->setFactory('db', function(ServiceProvider $c) {
- global $CONFIG;
- $db_config = new \Elgg\Database\Config($CONFIG);
- return new \Elgg\Database($db_config, $c->logger);
- });
- $this->setFactory('deprecation', function(ServiceProvider $c) {
- return new \Elgg\DeprecationService($c->session, $c->logger);
- });
- $this->setClassName('entityPreloader', '\Elgg\EntityPreloader');
- $this->setClassName('entityTable', '\Elgg\Database\EntityTable');
- $this->setFactory('events', function(ServiceProvider $c) {
- return $this->resolveLoggerDependencies('events');
- });
- $this->setFactory('externalFiles', function(ServiceProvider $c) {
- global $CONFIG;
- return new \Elgg\Assets\ExternalFiles($CONFIG);
- });
- $this->setFactory('hooks', function(ServiceProvider $c) {
- return $this->resolveLoggerDependencies('hooks');
- });
- $this->setClassName('input', 'Elgg\Http\Input');
- $this->setFactory('logger', function(ServiceProvider $c) {
- return $this->resolveLoggerDependencies('logger');
- });
- $this->setFactory('metadataCache', function (ServiceProvider $c) {
- return new \Elgg\Cache\MetadataCache($c->session);
- });
- $this->setFactory('metadataTable', function(ServiceProvider $c) {
- // TODO(ewinslow): Use Elgg\Cache\Pool instead of MetadataCache
- return new \Elgg\Database\MetadataTable(
- $c->metadataCache, $c->db, $c->entityTable, $c->events, $c->metastringsTable, $c->session);
- });
- $this->setFactory('metastringsTable', function(ServiceProvider $c) {
- // TODO(ewinslow): Use memcache-based Pool if available...
- $pool = new \Elgg\Cache\MemoryPool();
- return new \Elgg\Database\MetastringsTable($pool, $c->db);
- });
- $this->setFactory('notifications', function(ServiceProvider $c) {
- // @todo move queue in service provider
- $queue_name = \Elgg\Notifications\NotificationsService::QUEUE_NAME;
- $queue = new \Elgg\Queue\DatabaseQueue($queue_name, $c->db);
- $sub = new \Elgg\Notifications\SubscriptionsService($c->db);
- return new \Elgg\Notifications\NotificationsService($sub, $queue, $c->hooks, $c->session);
- });
- $this->setFactory('persistentLogin', function(ServiceProvider $c) {
- $global_cookies_config = _elgg_services()->config->get('cookies');
- $cookie_config = $global_cookies_config['remember_me'];
- $cookie_name = $cookie_config['name'];
- $cookie_token = $c->request->cookies->get($cookie_name, '');
- return new \Elgg\PersistentLoginService(
- $c->db, $c->session, $c->crypto, $cookie_config, $cookie_token);
- });
- $this->setFactory('passwords', function (ServiceProvider $c) {
- if (!function_exists('password_hash')) {
- $root = $c->config->getRootPath();
- require "{$root}vendor/ircmaxell/password-compat/lib/password.php";
- }
- return new \Elgg\PasswordService();
- });
- $this->setFactory('plugins', function(ServiceProvider $c) {
- return new \Elgg\Database\Plugins($c->events, new \Elgg\Cache\MemoryPool());
- });
- $this->setFactory('privateSettings', function(ServiceProvider $c) {
- return new \Elgg\Database\PrivateSettingsTable($c->db, $c->entityTable);
- });
- $this->setFactory('queryCounter', function(ServiceProvider $c) {
- return new \Elgg\Database\QueryCounter($c->db);
- }, false);
- $this->setClassName('relationshipsTable', '\Elgg\Database\RelationshipsTable');
- $this->setFactory('request', '\Elgg\Http\Request::createFromGlobals');
- $this->setFactory('router', function(ServiceProvider $c) {
- // TODO(evan): Init routes from plugins or cache
- return new \Elgg\Router($c->hooks);
- });
- $this->setFactory('session', function(ServiceProvider $c) {
- $params = $c->config->get('cookies')['session'];
- $options = [
- // session.cache_limiter is unfortunately set to "" by the NativeSessionStorage
- // constructor, so we must capture and inject it directly.
- 'cache_limiter' => session_cache_limiter(),
- 'name' => $params['name'],
- 'cookie_path' => $params['path'],
- 'cookie_domain' => $params['domain'],
- 'cookie_secure' => $params['secure'],
- 'cookie_httponly' => $params['httponly'],
- 'cookie_lifetime' => $params['lifetime'],
- ];
- $handler = new \Elgg\Http\DatabaseSessionHandler($c->db);
- $storage = new NativeSessionStorage($options, $handler);
- $session = new SymfonySession($storage);
- return new \ElggSession($session);
- });
- $this->setClassName('simpleCache', '\Elgg\Cache\SimpleCache');
- $this->setClassName('siteSecret', '\Elgg\Database\SiteSecret');
- $this->setClassName('stickyForms', 'Elgg\Forms\StickyForms');
- $this->setClassName('subtypeTable', '\Elgg\Database\SubtypeTable');
- $this->setClassName('systemCache', '\Elgg\Cache\SystemCache');
- $this->setFactory('systemMessages', function(ServiceProvider $c) {
- return new \Elgg\SystemMessagesService($c->session);
- });
- $this->setClassName('translator', '\Elgg\I18n\Translator');
- $this->setClassName('usersTable', '\Elgg\Database\UsersTable');
- $this->setFactory('views', function(ServiceProvider $c) {
- return new \Elgg\ViewsService($c->hooks, $c->logger);
- });
- $this->setClassName('widgets', '\Elgg\WidgetsService');
- }
- /**
- * Returns the first requested service of the logger, events, and hooks. It sets the
- * hooks and events up in the right order to prevent circular dependency.
- *
- * @param string $service_needed The service requested first
- * @return mixed
- */
- protected function resolveLoggerDependencies($service_needed) {
- $svcs['hooks'] = new \Elgg\PluginHooksService();
- $svcs['logger'] = new \Elgg\Logger($svcs['hooks']);
- $svcs['hooks']->setLogger($svcs['logger']);
- $svcs['events'] = new \Elgg\EventsService();
- $svcs['events']->setLogger($svcs['logger']);
- foreach ($svcs as $key => $service) {
- $this->setValue($key, $service);
- }
- return $svcs[$service_needed];
- }
- }
|