PageOwnerService.php

Go to the documentation of this file.

<?php

namespace Elgg\Page;

use Elgg\Database\EntityTable;
use Elgg\Database\UsersTable;
use Elgg\Exceptions\InvalidArgumentException;
use Elgg\Http\Request;
use Elgg\Invoker;
use Elgg\PluginHooksService;
use Elgg\Router\Route;

class PageOwnerService {

    protected $request;

    protected $entity_table;

    protected $users_table;

    protected $hooks;

    protected $invoker;

    protected $page_owner_guid = 0;
    
    public function __construct(
            Request $request,
            EntityTable $entity_table,
            PluginHooksService $hooks,
            UsersTable $users_table,
            Invoker $invoker
    ) {
        $this->request = $request;
        $this->entity_table = $entity_table;
        $this->hooks = $hooks;
        $this->users_table = $users_table;
        $this->invoker = $invoker;
        
        $this->initializePageOwner();
    }
    
    protected function initializePageOwner() {
        
        $page_owner_guid = $this->detectPageOwnerFromRoute();
        if (!empty($page_owner_guid)) {
            $this->page_owner_guid = $page_owner_guid;
            return;
        }
        
        $page_owner_guid = $this->detectLegacyPageOwner();
        if (!empty($page_owner_guid)) {
            $this->page_owner_guid = $page_owner_guid;
            return;
        }
        
        $this->page_owner_guid = (int) $this->hooks->triggerDeprecated('page_owner', 'system', null, $this->page_owner_guid, "No longer set page owner using the 'page_owner', 'system' hook. Use route definitions instead.", '4.3');
    }
    
    protected function detectPageOwnerFromRoute() {
        $route = $this->request->getRoute();
        if (!$route instanceof Route) {
            return;
        }
        
        $page_owner = $route->resolvePageOwner();
        if (!$page_owner instanceof \ElggEntity) {
            return;
        }
        
        return $page_owner->guid;
    }
    
    private function detectLegacyPageOwner() {
        $route = $this->request->getRoute();
        if ($route instanceof Route) {
            if ($route->getDefault('_legacy_page_owner_detection') === false) {
                return;
            }
        }
        
        $guid = $this->invoker->call(ELGG_IGNORE_ACCESS, function() {
        
            $username = $this->request->getParam('username');
            if ($user = $this->users_table->getByUsername($username)) {
                return $user->guid;
            }
        
            $owner = $this->request->getParam('owner_guid');
            if (is_numeric($owner)) {
                if ($user = $this->entity_table->get((int) $owner)) {
                    return $user->guid;
                }
            }
        });
        
        if (is_int($guid)) {
            if (!$this->request->isAction()) {
                elgg_deprecated_notice('The automatic legacy page owner detection based on request parameters has been deprecated. Use route definitions if possible.', '4.1');
            }
            return $guid;
        }
        
        $guid = $this->invoker->call(ELGG_IGNORE_ACCESS, function() {
            $segments = $this->request->getUrlSegments();
            if (!isset($segments[1]) || !isset($segments[2])) {
                return;
            }
            
            switch ($segments[1]) {
                case 'owner':
                case 'friends':
                    $user = $this->users_table->getByUsername($segments[2]);
                    if ($user) {
                        return $user->guid;
                    }
                    break;
                case 'view':
                case 'edit':
                    $entity = $this->entity_table->get($segments[2]);
                    if ($entity) {
                        return $entity->container_guid;
                    }
                    break;
                case 'add':
                case 'group':
                    $entity = $this->entity_table->get($segments[2]);
                    if ($entity) {
                        return $entity->guid;
                    }
                    break;
            }
        });
    
        if (is_int($guid)) {
            elgg_deprecated_notice('The automatic legacy page owner detection based on url segments has been deprecated. Use route definitions.', '4.1');
            return $guid;
        }
    }
    
    public function setPageOwnerGuid(int $guid = 0) {
        if ($guid < 0) {
            throw new InvalidArgumentException(__METHOD__ . ' requires a positive integer.');
        }
        $this->page_owner_guid = $guid;
    }
    
    public function getPageOwnerGuid() {
        return $this->page_owner_guid;
    }
    
    public function getPageOwnerEntity() {
        return $this->entity_table->get($this->getPageOwnerGuid());
    }
}