This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjMediaObjectAccess:

Collaboration diagram for ilObjMediaObjectAccess:

Public Member Functions
	__construct ()

	canBeDelivered (ilWACPath $ilWACPath)

Protected Member Functions
	checkAccessMob (int $obj_id)

	checkAccessObject (int $obj_id, string $obj_type='')
	Check access rights for an object by its object id. More...

	checkAccessTestQuestion (int $obj_id, int $usage_id=0)
	Check access rights for a test question This checks also tests with random selection of questions. More...

	checkAccessGlossaryTerm (int $obj_id, int $page_id)
	Check access rights for glossary terms This checks also learning modules linking the term. More...

	checkAccessPortfolioPage (int $obj_id, int $page_id)
	Check access rights for portfolio pages. More...

	checkAccessBlogPage (int $obj_id)
	Check access rights for blog pages. More...

	checkAccessLearningObjectivePage (int $obj_id, int $page_id)

Protected Attributes
ilObjectDataCache	$obj_data_cache

ilObjUser	$user

ilAccessHandler	$access

ilLogger	$logger

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilObjMediaObjectAccess

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 23 of file class.ilObjMediaObjectAccess.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjMediaObjectAccess::__construct ( )

Definition at line 30 of file class.ilObjMediaObjectAccess.php.

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\logger(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->obj_data_cache = $DIC["ilObjDataCache"];
         $this->user = $DIC->user();
         $this->access = $DIC->access();
         $this->logger = $DIC->logger()->mob();
     }

Here is the call graph for this function:

Member Function Documentation

◆ canBeDelivered()

ilObjMediaObjectAccess::canBeDelivered ( ilWACPath $ilWACPath )

Implements ilWACCheckingClass.

Definition at line 40 of file class.ilObjMediaObjectAccess.php.

References checkAccessMob(), and ilWACPath\getPath().

                                                         : bool
     {
         preg_match("/.\\/public\/data\\/.*\\/mm_([0-9]*)\\/.*/ui", $ilWACPath->getPath(), $matches);
         $obj_id = $matches[1] ?? 0;
 
         return $this->checkAccessMob($obj_id);
     }

Here is the call graph for this function:

◆ checkAccessBlogPage()

ilObjMediaObjectAccess::checkAccessBlogPage ( int $obj_id )

protected

Check access rights for blog pages.

Parameters

int $obj_id blog page id

Definition at line 340 of file class.ilObjMediaObjectAccess.php.

References $user, and checkAccessObject().

Referenced by checkAccessMob().

      : bool {
         $ilUser = $this->user;
         $tree = new ilWorkspaceTree(0);
         $node_id = $tree->lookupNodeId($obj_id);
         if (!$node_id) {
             return $this->checkAccessObject($obj_id);
         } else {
             $access_handler = new ilWorkspaceAccessHandler($tree);
             if ($access_handler->checkAccessOfUser($tree, $ilUser->getId(), "read", "view", $node_id, "blog")) {
                 return true;
             }
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkAccessGlossaryTerm()

ilObjMediaObjectAccess::checkAccessGlossaryTerm	(	int	$obj_id,
		int	$page_id
	)

protected

Check access rights for glossary terms This checks also learning modules linking the term.

Parameters

int	$obj_id	object id (glossary)
int	$page_id	page id (definition)

Returns: bool access given (true/false)

Definition at line 273 of file class.ilObjMediaObjectAccess.php.

References ilInternalLink\_getSourcesOfTarget(), ilLMObject\_lookupContObjID(), and checkAccessObject().

Referenced by checkAccessMob().

      : bool {
         // give access if glossary is readable
         if ($this->checkAccessObject($obj_id)) {
             return true;
         }
 
         $term_id = $page_id;
 
         $sources = ilInternalLink::_getSourcesOfTarget('git', $term_id, 0);
 
         if ($sources) {
             foreach ($sources as $src) {
                 switch ($src['type']) {
                     // Give access if term is linked by a learning module with read access.
                     // The term including media is shown by the learning module presentation!
                     case 'lm:pg':
                         $src_obj_id = ilLMObject::_lookupContObjID($src['id']);
                         if ($this->checkAccessObject($src_obj_id, 'lm')) {
                             return true;
                         }
                         break;
 
                         // Don't yet give access if the term is linked by another glossary
                         // The link will lead to the origin glossary which is already checked
                         /*
                         case 'gdf:pg':
                             $src_term_id = ilGlossaryDefinition::_lookupTermId($src['id']);
                             $src_obj_id = ilGlossaryTerm::_lookGlossaryID($src_term_id);
                             if ($this->checkAccessObject($src_obj_id, 'glo'))
                             {
                                 return true;
                             }
                             break;
                         */
                 }
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkAccessLearningObjectivePage()

ilObjMediaObjectAccess::checkAccessLearningObjectivePage	(	int	$obj_id,
		int	$page_id
	)

protected

Definition at line 359 of file class.ilObjMediaObjectAccess.php.

References ilCourseObjective\_lookupContainerIdByObjectiveId(), and checkAccessObject().

Referenced by checkAccessMob().

      : bool {
         $crs_obj_id = ilCourseObjective::_lookupContainerIdByObjectiveId($page_id);
 
         return $this->checkAccessObject($crs_obj_id, 'crs');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkAccessMob()

ilObjMediaObjectAccess::checkAccessMob ( int $obj_id )

protected

Definition at line 48 of file class.ilObjMediaObjectAccess.php.

References $obj_data_cache, $user, $user_id, ilObjMediaCastAccess\_lookupPublicFiles(), ilNewsItem\_lookupVisibility(), checkAccessBlogPage(), checkAccessGlossaryTerm(), checkAccessLearningObjectivePage(), checkAccessObject(), checkAccessPortfolioPage(), checkAccessTestQuestion(), ilObjMediaObject\getParentObjectIdForUsage(), ilImprint\isActive(), ILIAS\Repository\logger(), ilMediaPoolPage\lookupUsages(), ilObjMediaObject\lookupUsages(), ilForumPostDraft\newInstanceByDraftId(), NEWS_PUBLIC, null, SYSTEM_FOLDER_ID, and ILIAS\Repository\user().

Referenced by canBeDelivered().

      : bool {
 
         foreach (ilObjMediaObject::lookupUsages($obj_id) as $usage) {
             $oid = ilObjMediaObject::getParentObjectIdForUsage($usage, true);
             // for content snippets we must get their usages and check them
             switch ($usage["type"]) {
                 case "auth:pg":
                     // Mobs on the Loginpage should always be delivered
                     return true;
                 case "mep:pg":
                     $usages2 = ilMediaPoolPage::lookupUsages($usage["id"]);
                     foreach ($usages2 as $usage2) {
                         $oid2 = ilObjMediaObject::getParentObjectIdForUsage($usage2, true);
                         if ($this->checkAccessMobUsage($usage2, $oid2)) {
                             return true;
                         }
                     }
                     break;
 
                 case "clip":
                     if ($usage["id"] == $this->user->getId()) {
                         return true;
                     }
                     break;
 
                 default:
                     if ($oid !== null && $this->checkAccessMobUsage($usage, $oid)) {
                         return true;
                     }
 
                     if ($oid === null) {
                         $this->logger->error(
                             sprintf(
                                 "Could not determine parent obj_id for usage: %s",
                                 json_encode($usage, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT)
                             )
                         );
                     }
                     break;
             }
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkAccessObject()

ilObjMediaObjectAccess::checkAccessObject	(	int	$obj_id,
		string	$obj_type = `''`
	)

protected

Check access rights for an object by its object id.

Definition at line 211 of file class.ilObjMediaObjectAccess.php.

References $access, $ref_id, $user, $user_id, ilObject\_getAllReferences(), and ilObject\_lookupType().

Referenced by checkAccessBlogPage(), checkAccessGlossaryTerm(), checkAccessLearningObjectivePage(), checkAccessMob(), and checkAccessTestQuestion().

      : bool {
         $ilAccess = $this->access;
         $ilUser = $this->user;
         $user_id = $ilUser->getId();
 
         if (!$obj_type) {
             $obj_type = ilObject::_lookupType($obj_id);
         }
         $ref_ids = ilObject::_getAllReferences($obj_id);
 
         foreach ($ref_ids as $ref_id) {
             //                  foreach ($this->check_users as $user_id) {
             if ($ilAccess->checkAccessOfUser($user_id, "read", "view", $ref_id, $obj_type, $obj_id)) {
                 return true;
             }
             //                  }
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkAccessPortfolioPage()

ilObjMediaObjectAccess::checkAccessPortfolioPage	(	int	$obj_id,
		int	$page_id
	)

protected

Check access rights for portfolio pages.

Parameters

int	$obj_id	object id (glossary)
int	$page_id	page id (definition)

Definition at line 322 of file class.ilObjMediaObjectAccess.php.

References $user.

Referenced by checkAccessMob().

      : bool {
         $ilUser = $this->user;
         $access_handler = new ilPortfolioAccessHandler();
         if ($access_handler->checkAccessOfUser($ilUser->getId(), "read", "view", $obj_id, "prtf")) {
             return true;
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ checkAccessTestQuestion()

ilObjMediaObjectAccess::checkAccessTestQuestion	(	int	$obj_id,
		int	$usage_id = `0`
	)

protected

Check access rights for a test question This checks also tests with random selection of questions.

Parameters

int $obj_id object id (question pool or test)

Definition at line 241 of file class.ilObjMediaObjectAccess.php.

References ilObjTestAccess\_getRandomTestsForQuestionPool(), ilObject\_lookupType(), and checkAccessObject().

Referenced by checkAccessMob().

      : bool {
         // give access if direct usage is readable
         if ($this->checkAccessObject($obj_id)) {
             return true;
         }
 
         $obj_type = ilObject::_lookupType($obj_id);
         if ($obj_type == 'qpl') {
             // give access if question pool is used by readable test
             // for random selection of questions
             $tests = ilObjTestAccess::_getRandomTestsForQuestionPool($obj_id);
             foreach ($tests as $test_id) {
                 if ($this->checkAccessObject($test_id, 'tst')) {
                     return true;
                 }
             }
         }
 
         return false;
     }