class for checking external links in page objects Normally used in Cron jobs, but should be extensible for use in learning modules. More...

Collaboration diagram for ilLinkChecker:

Public Member Functions
	__construct ($db, $a_validate_all=true)

	setCheckPeriod ($a_period)

	getCheckPeriod ()

	setMailStatus ($a_status)

	getMailStatus ()

	__setType ($a_type)

	__getType ()

	setObjId ($a_page_id)

	getObjId ()

	getValidateAll ()

	getLogMessages ()

	getInvalidLinks ()

	getInvalidLinksFromDB ()

	getLastCheckTimestamp ()

	checkWebResourceLinks ()

	checkLinks ()

	__txt ($language, $key, $module='common')

	__fetchUserData ($a_usr_id)

	__getTitle ($a_lm_obj_id)

	__sendMail ()

	__getNotifyLinks ()

	__clearInvalidLinks ()

	__appendInvalidLink ($a_link)

	__appendLogMessage ($a_string)

	__clearLogMessages ()

	__getLinks ($a_page)

	__getWebResourceLinks ()

	__validateLinks ($a_links)
	$a_links Format: Array ( [1] => Array ( ['scheme'] => intern/http/https, ['ref_id'] => ILIAS ref ID, ['obj_type'] => ILIAS object type, ['complete'] => link to check, ), [2]=> ... More...

	__getObjIdByPageId ($a_page_id)

	__isInvalid ($a_page_id, $a_url)

	__saveInDB ()

	__checkNotify ()

	__clearDBData ()

Data Fields
	$db = null

	$log_messages = array()

	$invalid_links = array()

	$validate_all = true

	$mail_status = false

	$page_id = 0

Protected Member Functions
	createPermanentLink ($a_obj_id, $a_usr_id, $a_obj_type)
	creates a permanent link More...

Detailed Description

class for checking external links in page objects Normally used in Cron jobs, but should be extensible for use in learning modules.

In this case set second parameter of contructor = false, and use setPageObjectId()

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 12 of file class.ilLinkChecker.php.

Constructor & Destructor Documentation

◆ __construct()

ilLinkChecker::__construct	(	$db,
		$a_validate_all = `true`
	)

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

References $db, and $ilDB.

         {
                 global $ilDB;
 
                 define('DEBUG',1);
                 define('SOCKET_TIMEOUT',5);
                 define('MAX_REDIRECTS',5);
 
                 $this->db = $db;
 
                 // SET GLOBAL DB HANDLER FOR STATIC METHODS OTHER CLASSES
                 $ilDB = $db;
 
                 $this->validate_all = $a_validate_all;
         }

Member Function Documentation

◆ __appendInvalidLink()

ilLinkChecker::__appendInvalidLink ( $a_link )

Definition at line 375 of file class.ilLinkChecker.php.

Referenced by checkLinks(), and checkWebResourceLinks().

         {
                 $this->invalid_links[] = $a_link;
         }

Here is the caller graph for this function:

◆ __appendLogMessage()

ilLinkChecker::__appendLogMessage ( $a_string )

Definition at line 381 of file class.ilLinkChecker.php.

Referenced by __sendMail(), __validateLinks(), checkLinks(), and checkWebResourceLinks().

         {
                 $this->log_messages[] = $a_string;
         }

Here is the caller graph for this function:

◆ __checkNotify()

ilLinkChecker::__checkNotify ( )

Definition at line 629 of file class.ilLinkChecker.php.

References $ilDB, $query, $res, array, and getInvalidLinks().

Referenced by __saveInDB().

         {
                 global $ilDB;
                 
                 foreach($this->getInvalidLinks() as $link)
                 {
                         $query = "SELECT * FROM link_check ".
                                 "WHERE page_id = ".$ilDB->quote($link['page_id'],'integer')." ".
                                 "AND url = ".$ilDB->quote(substr($link['complete'],0,255),'text')." ";
                         $res = $ilDB->query($query);
                                                 
                         if(!$res->numRows())
                         {
                                 $this->notify[$link["obj_id"]][] = array('page_id' => $link['page_id'],
                                                                                                                  'url'     => $link['complete']);
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __clearDBData()

ilLinkChecker::__clearDBData ( )

Definition at line 649 of file class.ilLinkChecker.php.

References $ilDB, $query, $res, getObjId(), and getValidateAll().

Referenced by __saveInDB().

         {
                 global $ilDB;
                 
                 if($this->getValidateAll())
                 {
                         $query = "DELETE FROM link_check";
                 }
                 else
                 {
                         $query = "DELETE FROM link_check ".
                                 "WHERE obj_id = ".$ilDB->quote($this->getObjId(),'integer');
                 }
                 $res = $ilDB->manipulate($query);
 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __clearInvalidLinks()

ilLinkChecker::__clearInvalidLinks ( )

Definition at line 371 of file class.ilLinkChecker.php.

References array.

Referenced by checkLinks(), and checkWebResourceLinks().

         {
                 $this->invalid_links = array();
         }

Here is the caller graph for this function:

◆ __clearLogMessages()

ilLinkChecker::__clearLogMessages ( )

Definition at line 385 of file class.ilLinkChecker.php.

References array.

Referenced by checkLinks(), and checkWebResourceLinks().

         {
                 return $this->log_messages = array();
         }

Here is the caller graph for this function:

◆ __fetchUserData()

ilLinkChecker::__fetchUserData ( $a_usr_id )

Definition at line 227 of file class.ilLinkChecker.php.

References $data, $ilDB, $r, $row, and ilDBConstants\FETCHMODE_OBJECT.

         {
                 global $ilDB;
 
                 $r = $this->db->query("SELECT email FROM usr_data WHERE usr_id = ".$ilDB->quote($a_usr_id));
 
                 $row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
 
                 $data['email'] = $row->email;
 
                 $set = $ilDB->query("SELECT * FROM usr_pref ".
                         "WHERE usr_id = ".$ilDB->quote($a_usr_id, "integer")." ".
                         "AND keyword = ".$ilDB->quote('language', "text"));
 
                 $row = $ilDB->fetchObject($set);
 
                 $data['lang'] = $row->value;
 
                 return $data;
         }

◆ __getLinks()

ilLinkChecker::__getLinks ( $a_page )

Definition at line 390 of file class.ilLinkChecker.php.

References __getObjIdByPageId(), and array.

Referenced by checkLinks().

         {
                 $matches = array();
 
                 $pattern_complete = '/<ExtLink Href="([^"]*)">/';
                 if(preg_match_all($pattern_complete,$a_page['content'],$matches))
                 {
                         for($i = 0;$i < count($matches[0]); ++$i)
                         {
                                 $url_data = @parse_url($matches[1][$i]);
                                 // continue if mailto link
                                 if($url_data['scheme'] == 'mailto')
                                 {
                                         continue;
                                 }
                                 
                                 // PUH, HTTP_REQUEST needs a beginning http://
                                 if(!$url_data['scheme'])
                                 {
                                         $matches[1][$i] = 'http://'.$matches[1][$i];
                                 }
 
                                 $lm_id = $this->__getObjIdByPageId($a_page['page_id']);
                                 $link[] = array('page_id'  => $a_page['page_id'],
                                                                 'obj_id'   => $lm_id,
                                                                 'type'     => $a_page['type'],
                                                                 'complete' => $matches[1][$i],
                                                                 'scheme'   => isset($url_data['scheme']) ? $url_data['scheme'] : 'http',
                                                                 'host'     => isset($url_data['host']) ? $url_data['host'] : $url_data['path']);
                         }
                 }
 
                 return $link ? $link : array();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __getNotifyLinks()

ilLinkChecker::__getNotifyLinks ( )

Definition at line 365 of file class.ilLinkChecker.php.

References array.

Referenced by __sendMail().

         {
                 return $this->notify ? $this->notify : array();
         }

Here is the caller graph for this function:

◆ __getObjIdByPageId()

ilLinkChecker::__getObjIdByPageId ( $a_page_id )

Definition at line 577 of file class.ilLinkChecker.php.

References $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by __getLinks().

         {
                 $res = $this->db->query( "SELECT lm_id FROM lm_data ".
                         "WHERE obj_id = '".$a_page_id."'");
 
                 $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
 
                 return $row->lm_id ? $row->lm_id : 0;
         }

Here is the caller graph for this function:

◆ __getTitle()

ilLinkChecker::__getTitle ( $a_lm_obj_id )

Definition at line 248 of file class.ilLinkChecker.php.

References $ilDB, $r, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by __sendMail().

         {
                 global $ilDB;
 
                 $r = $this->db->query("SELECT title FROM object_data ".
                         "WHERE obj_id = ".$ilDB->quote($a_lm_obj_id ,'integer')." ");
 
                 $row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
 
                 return $row->title;
         }

Here is the caller graph for this function:

◆ __getType()

ilLinkChecker::__getType ( )

Definition at line 61 of file class.ilLinkChecker.php.

Referenced by __sendMail().

         {
                 return $this->type;
         }

Here is the caller graph for this function:

◆ __getWebResourceLinks()

ilLinkChecker::__getWebResourceLinks ( )

Definition at line 425 of file class.ilLinkChecker.php.

References array, and getObjId().

Referenced by checkWebResourceLinks().

         {
                 global $objDefinition;
                 
                 include_once 'Modules/WebResource/classes/class.ilLinkResourceItems.php';
 
                 $link_res_obj = new ilLinkResourceItems($this->getObjId());
 
                 foreach($check_links = $link_res_obj->getCheckItems($this->getCheckPeriod()) as $item_data)
                 {
                         // #10091 - internal
                         if(strpos($item_data['target'], '|'))
                         {                               
                                 $parts = explode('|', $item_data['target']);
                                 if(sizeof($parts) == 2 &&
                                         is_numeric($parts[1]) &&
                                         $objDefinition->isAllowedInRepository($parts[0]))
                                 {                                                                               
                                         $link[] = array('page_id'  => $item_data['link_id'],
                                                                 'obj_id'   => $this->getObjId(),
                                                                 'type'     => 'webr',
                                                                 'complete' => $item_data['target'],
                                                                 'scheme'   => 'internal',
                                                                 'obj_type' => $parts[0],
                                                                 'ref_id'   => $parts[1]);                       
                                         continue;
                                 }                                       
                         }
                         
                         // external                     
                         $url_data = @parse_url($item_data['target']);
 
                         // PUH, HTTP_REQUEST needs a beginning http://
                         if(!$url_data['scheme'])
                         {
                                 $item_data['target'] = 'http://'.$item_data['target'];
                         }
 
                         $link[] = array('page_id'  => $item_data['link_id'],
                                                 'obj_id'   => $this->getObjId(),
                                                 'type'     => 'webr',
                                                 'complete' => $item_data['target'],
                                                 'scheme'   => isset($url_data['scheme']) ? $url_data['scheme'] : 'http',
                                                 'host'     => isset($url_data['host']) ? $url_data['host'] : $url_data['path']);                                                                                
                 }
                 return $link ? $link : array();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __isInvalid()

ilLinkChecker::__isInvalid	(	$a_page_id,
		$a_url
	)

Definition at line 587 of file class.ilLinkChecker.php.

References getInvalidLinks().

         {
                 foreach($this->getInvalidLinks() as $link)
                 {
                         if($link['page_id'] == $a_page_id and
                            substr($link['complete'],0,255) == $a_url)
                         {
                                 return true;
                         }
                 }
                 return false;
         }

Here is the call graph for this function:

◆ __saveInDB()

ilLinkChecker::__saveInDB ( )

Definition at line 600 of file class.ilLinkChecker.php.

References $ilDB, $query, $res, __checkNotify(), __clearDBData(), getInvalidLinks(), getMailStatus(), and time.

Referenced by checkLinks(), and checkWebResourceLinks().

         {
                 global $ilDB;
                 
                 if($this->getMailStatus())
                 {
                         $this->__checkNotify();
                 }
                 $this->__clearDBData();
 
 
                 foreach($this->getInvalidLinks() as $link)
                 {
                         $id = $ilDB->nextId('link_check');
 
                         $query = "INSERT INTO link_check (id, obj_id,page_id,url,parent_type,http_status_code,last_check) ".
                                 "VALUES ( ".
                                 $ilDB->quote($id, "integer").",".
                                 $ilDB->quote($link['obj_id'],'integer').", ".
                                 $ilDB->quote($link['page_id'],'integer').", ".
                                 $ilDB->quote(substr($link['complete'],0,255),'text').", ".
                                 $ilDB->quote($link['type'],'text').", ".
                                 $ilDB->quote($link['http_status_code'] ? $link['http_status_code'] : 0,'integer').", ".
                                 $ilDB->quote(time(),'integer')." ".
                                 ")";
                         $res = $ilDB->manipulate($query);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __sendMail()

ilLinkChecker::__sendMail ( )

Definition at line 260 of file class.ilLinkChecker.php.

References $counter, $data, $ilUser, __appendLogMessage(), __getNotifyLinks(), __getTitle(), __getType(), __txt(), ilLinkCheckNotify\_getAllNotifiers(), array, createPermanentLink(), ilObjectFactory\getInstanceByObjId(), and getMailStatus().

Referenced by checkLinks(), and checkWebResourceLinks().

         {
                 global $ilUser;
 
 
                 if(!count($notify = $this->__getNotifyLinks()))
                 {
                         // Nothing to do
                         return true;
                 }
                 if(!$this->getMailStatus())
                 {
                         return true;
                 }
 
                 include_once './Services/LinkChecker/classes/class.ilLinkCheckNotify.php';
                 $body = "";
                 $obj_name = "";
 
                 foreach(ilLinkCheckNotify::_getAllNotifiers($this->db) as $usr_id => $obj_ids)
                 {
                         if(!is_object($tmp_user =& ilObjectFactory::getInstanceByObjId($usr_id,false)))
                         {
                                 $this->__appendLogMessage('LinkChecker: Cannot find user with id: '.$usr_id);
                                 continue;
                         }
 
                         $counter = 0;
                         foreach($obj_ids as $obj_id)
                         {
                                 if(!isset($notify[$obj_id]))
                                 {
                                         continue;
                                 }
                                 ++$counter;
 
                                 switch($this->__getType())
                                 {
                                         case 'webr':
                                                 $obj_name = $this->__txt($tmp_user->getLanguage(),'obj_webr');
                                                 break;
                                         case 'lm':
                                         default:
                                                 $obj_name = $this->__txt($tmp_user->getLanguage(),'lo');
                                                 break;
                                 }
                                 $body .= $obj_name.': '.$this->__getTitle($obj_id)."\r\n";
                                 $body .= $this->__txt($tmp_user->getLanguage(),'link_check_perma_link', "mail"). ": " .
                                         $this->createPermanentLink($obj_id, $usr_id, $this->__getType())." \r\n";
                                 $body .= $this->__txt($tmp_user->getLanguage(),"link_check_affected_links", "mail"). ":\r\n";
 
                                 // Print all invalid
                                 foreach($notify[$obj_id] as $data)
                                 {
                                         $body .= $data['url']."\r\n";
                                 }
                                 $body .= "\r\n";
                         }
                         if($counter)
                         {
                                 include_once "./Services/Notification/classes/class.ilSystemNotification.php";
                                 $ntf = new ilSystemNotification();
                                 $ntf->setLangModules(array("mail", "common"));
                                 $ntf->setSubjectLangId("link_check_subject");
                                 $ntf->setIntroductionLangId("link_check_introduction");
                                 $ntf->setReasonLangId("link_check_reason");
                                 $ntf->addAdditionalInfo("additional_info", $body,true);
                                 $ntf->sendMail(array($tmp_user->getId()));
 
                                 $this->__appendLogMessage('LinkChecker: Sent mail to '.$tmp_user->getEmail());
                         }
                         $body = "";
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __setType()

ilLinkChecker::__setType ( $a_type )

Definition at line 57 of file class.ilLinkChecker.php.

References $a_type.

Referenced by checkLinks(), and checkWebResourceLinks().

         {
                 $this->type = $a_type;
         }

Here is the caller graph for this function:

◆ __txt()

ilLinkChecker::__txt	(	$language,
		$key,
		$module = `'common'`
	)

Definition at line 219 of file class.ilLinkChecker.php.

References $ilDB, and ilLanguage\_lookupEntry().

Referenced by __sendMail().

         {
                 global $ilDB;
                 
                 include_once './Services/Language/classes/class.ilLanguage.php';
                 return ilLanguage::_lookupEntry($language, $module, $key);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __validateLinks()

ilLinkChecker::__validateLinks ( $a_links )

$a_links Format: Array ( [1] => Array ( ['scheme'] => intern/http/https, ['ref_id'] => ILIAS ref ID, ['obj_type'] => ILIAS object type, ['complete'] => link to check, ), [2]=> ...

)

Parameters

array $a_links Format:

Returns: array Returns all invalid links! Format like $a_links with additional error information ['http_status_code'] and ['curl_errno']

Definition at line 490 of file class.ilLinkChecker.php.

References __appendLogMessage(), ilProxySettings\_getInstance(), ilCurlConnection\_isCurlExtensionLoaded(), ilObject\_lookupObjId(), ilObject\_lookupType(), array, and ilLoggerFactory\getLogger().

Referenced by checkLinks(), and checkWebResourceLinks().

         {
                 global $tree;
                 include_once('./Services/Logging/classes/public/class.ilLoggerFactory.php');
                 include_once('./Services/WebServices/Curl/classes/class.ilCurlConnection.php');
                 if(!ilCurlConnection::_isCurlExtensionLoaded())
                 {
                         $this->__appendLogMessage('LinkChecker: Pear HTTP_Request is not installed. Aborting');
                         ilLoggerFactory::getLogger('lchk')->error('LinkChecker: Curl extension is not loeaded. Aborting');
                         return array();
                 }
                 $invalid = array();
 
                 foreach($a_links as $link)
                 {
                         // #10091 - internal
                         if($link['scheme'] == 'internal')
                         {                               
                                 $obj_id = ilObject::_lookupObjId($link['ref_id']);
                                 if(!$obj_id || 
                                         ilObject::_lookupType($obj_id) != $link['obj_type'] ||
                                         $tree->isDeleted($link['ref_id']))
                                 {                                       
                                         $invalid[] = $link;
                                 }                                       
                         }
                         // external
                         else
                         {
                                 if($link['scheme'] !== 'http' and $link['scheme'] !== 'https')
                                 {
                                         ilLoggerFactory::getLogger('lchk')->error('LinkChecker: Unkown link sheme "' . $link['scheme'] . '". Continue check');
                                         continue;
                                 }
 
                                 require_once './Services/Http/classes/class.ilProxySettings.php';
                                 $http_code = 0;
                                 $c_error_no = 0;
                                 try
                                 {
                                         $curl = new ilCurlConnection($link['complete']);
                                         $curl->init();
 
                                         if(ilProxySettings::_getInstance()->isActive())
                                         {
                                                 $curl->setOpt(CURLOPT_HTTPPROXYTUNNEL,true );
                                                 $curl->setOpt(CURLOPT_PROXY, ilProxySettings::_getInstance()->getHost());
                                                 $curl->setOpt(CURLOPT_PROXYPORT, ilProxySettings::_getInstance()->getPort());
                                         }
 
                                         $curl->setOpt( CURLOPT_HEADER, 1);
                                         $curl->setOpt(CURLOPT_RETURNTRANSFER, 1);
                                         $curl->setOpt(CURLOPT_CONNECTTIMEOUT ,SOCKET_TIMEOUT);
                                         $curl->setOpt(CURLOPT_FOLLOWLOCATION, 1);
                                         $curl->setOpt(CURLOPT_MAXREDIRS ,MAX_REDIRECTS);
                                         $curl->exec();
                                         $headers = $curl->getInfo();
                                         $http_code  = $headers['http_code'];
                                 }
                                 catch(ilCurlConnectionException $e)
                                 {
                                         $c_error_no = $e->getCode();
                                         ilLoggerFactory::getLogger('lchk')->error('LinkChecker: No valid http code received. Curl error ('.$e->getCode().'): ' . $e->getMessage());
                                 }
 
                                 switch($http_code)
                                 {
                                         // EVERYTHING OK
                                         case '200':
                                                 // In the moment 301 will be handled as ok
                                         case '301':
                                         case '302':
                                                 break;
                                         default:
                                                 $link['http_status_code'] = $http_code;
                                                 if($http_code == 0 && $c_error_no != 0)
                                                 {
                                                         $link['curl_errno'] = $c_error_no;
                                                 }
                                                 $invalid[] = $link;
                                                 break;
                                 }
                         }
                 }
                 return $invalid;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkLinks()

ilLinkChecker::checkLinks ( )

Definition at line 152 of file class.ilLinkChecker.php.

References $ilDB, $query, $res, $row, __appendInvalidLink(), __appendLogMessage(), __clearInvalidLinks(), __clearLogMessages(), __getLinks(), __saveInDB(), __sendMail(), __setType(), __validateLinks(), array, ilDBConstants\FETCHMODE_OBJECT, getInvalidLinks(), getObjId(), and getValidateAll().

         {
                 global $ilDB;
                 
                 $pages = array();
 
                 $this->__setType('lm');
                 $this->__clearLogMessages();
                 $this->__clearInvalidLinks();
                 $this->__appendLogMessage('LinkChecker: Start checkLinks()');
 
                 if(!$this->getValidateAll() and !$this->getObjId())
                 {
                         echo "ilLinkChecker::checkLinks() No Page id given";
 
                         return false;
                 }
                 elseif(!$this->getValidateAll() and $this->getObjId())
                 {
                         $query = "SELECT * FROM page_object ".
                                 "WHERE parent_id = ".$ilDB->quote($this->getObjId())." ".
                                 "AND parent_type = 'lm'";
 
                         $res = $this->db->query($query);
                         while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                         {
                                 $pages[] = array('page_id' => $row->page_id,
                                                                  'content' => $row->content,
                                                                  'type'  => $row->parent_type);
                         }
                 }
                 elseif($this->getValidateAll())
                 {
                         $query = "SELECT * FROM page_object ".
                                 "WHERE parent_type = 'lm'";
 
                         $res = $this->db->query($query);
                         while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                         {
                                 $pages[] = array('page_id' => $row->page_id,
                                                                  'content' => $row->content,
                                                                  'type'  => $row->parent_type);
                         }
                 }
 
                 // VALIDATE
                 foreach($pages as $page)
                 {
                         if(count($invalid = $this->__validateLinks($this->__getLinks($page))))
                         {
                                 foreach($invalid as $invalid_item)
                                 {
                                         $this->__appendLogMessage('LinkChecker: found invalid link: '.$invalid_item['complete']);
                                         $this->__appendInvalidLink($invalid_item);
                                 }
                         }
                 }
                 
                 $this->__appendLogMessage('LinkChecker: End checkLinks()');
                 $this->__saveInDB();
 
                 $this->__sendMail();
 
                 return $this->getInvalidLinks();
         }

Here is the call graph for this function:

◆ checkWebResourceLinks()

ilLinkChecker::checkWebResourceLinks ( )

Definition at line 126 of file class.ilLinkChecker.php.

References __appendInvalidLink(), __appendLogMessage(), __clearInvalidLinks(), __clearLogMessages(), __getWebResourceLinks(), __saveInDB(), __sendMail(), __setType(), __validateLinks(), array, and getInvalidLinks().

         {
                 $pages = array();
 
                 $this->__setType('webr');
                 $this->__clearLogMessages();
                 $this->__clearInvalidLinks();
                 $this->__appendLogMessage('LinkChecker: Start checkLinks()');
 
                 if(count($invalid = $this->__validateLinks($this->__getWebResourceLinks())))
                 {
                         foreach($invalid as $invalid_item)
                         {
                                 $this->__appendLogMessage('LinkChecker: found invalid link: '.$invalid_item['complete']);
                                 $this->__appendInvalidLink($invalid_item);
                         }
                 }
                 
                 $this->__appendLogMessage('LinkChecker: End checkLinks()');
                 $this->__saveInDB();
                 
                 $this->__sendMail();
                 
                 return $this->getInvalidLinks();
         }

Here is the call graph for this function:

◆ createPermanentLink()

ilLinkChecker::createPermanentLink	(	$a_obj_id,
		$a_usr_id,
		$a_obj_type
	)

protected

creates a permanent link

Parameters

$a_obj_id
$a_usr_id
$a_obj_type

Returns: string goto link

Definition at line 342 of file class.ilLinkChecker.php.

References $ref_id, ilObject\_getAllReferences(), ilLink\_getLink(), and array.

Referenced by __sendMail().

         {
                 global $ilAccess;
                 $ref_ids = ilObject::_getAllReferences($a_obj_id);
                 $ref_id = null;
 
                 foreach((array) $ref_ids as $id)
                 {
                         if($ilAccess->checkAccessOfUser($a_usr_id, "read", "", $id, $a_obj_type, $a_obj_id))
                         {
                                 $ref_id = $id;
                         }
                 }
 
                 if($ref_id === null)
                 {
                         return false;
                 }
 
                 include_once './Services/Link/classes/class.ilLink.php';
                 return ilLink::_getLink($ref_id, $a_obj_type);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCheckPeriod()

ilLinkChecker::getCheckPeriod ( )

Definition at line 43 of file class.ilLinkChecker.php.

         {
                 return $this->period;
         }

◆ getInvalidLinks()

ilLinkChecker::getInvalidLinks ( )

Definition at line 85 of file class.ilLinkChecker.php.

References array.

Referenced by __checkNotify(), __isInvalid(), __saveInDB(), checkLinks(), and checkWebResourceLinks().

         {
                 return $this->invalid_links ? $this->invalid_links : array();
         }

Here is the caller graph for this function:

◆ getInvalidLinksFromDB()

ilLinkChecker::getInvalidLinksFromDB ( )

Definition at line 90 of file class.ilLinkChecker.php.

References $ilDB, $query, $res, $row, array, ilDBConstants\FETCHMODE_OBJECT, and getObjId().

         {
                 global $ilDB;
                 
                 $query = "SELECT * FROM link_check ".
                         "WHERE obj_id = ".$ilDB->quote($this->getObjId(),'integer')." ";
 
                 $res = $this->db->query($query);
                 while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                 {
                         $invalid[] = array('page_id' => $row->page_id,
                                                            'url'         => $row->url);
                 }
 
                 return $invalid ? $invalid : array();
         }

Here is the call graph for this function:

◆ getLastCheckTimestamp()

ilLinkChecker::getLastCheckTimestamp ( )

Definition at line 107 of file class.ilLinkChecker.php.

References $ilDB, $query, $res, $row, getObjId(), and getValidateAll().

         {
                 global $ilDB;           
                 
                 if($this->getValidateAll())
                 {
                         $query = "SELECT MAX(last_check) last_check FROM link_check ";
                 }
                 else
                 {
                         $query = "SELECT MAX(last_check) last_check FROM link_check ".
                                 "WHERE obj_id = ".$ilDB->quote($this->getObjId(),'integer')." ";
                 }
                 $res = $ilDB->query($query);
                 $row = $ilDB->fetchObject($res);
 
                 return $row->last_check ? $row->last_check : 0;
         }

Here is the call graph for this function:

◆ getLogMessages()

ilLinkChecker::getLogMessages ( )

Definition at line 80 of file class.ilLinkChecker.php.

References array.

         {
                 return $this->log_messages ? $this->log_messages : array();
         }

◆ getMailStatus()

ilLinkChecker::getMailStatus ( )

Definition at line 52 of file class.ilLinkChecker.php.

References $mail_status.

Referenced by __saveInDB(), and __sendMail().

         {
                 return (bool) $this->mail_status;
         }

Here is the caller graph for this function:

◆ getObjId()

ilLinkChecker::getObjId ( )

Definition at line 70 of file class.ilLinkChecker.php.

References $page_id.

Referenced by __clearDBData(), __getWebResourceLinks(), checkLinks(), getInvalidLinksFromDB(), and getLastCheckTimestamp().

         {
                 return $this->page_id;
         }

Here is the caller graph for this function:

◆ getValidateAll()

ilLinkChecker::getValidateAll ( )

Definition at line 75 of file class.ilLinkChecker.php.

Referenced by __clearDBData(), checkLinks(), and getLastCheckTimestamp().

         {
                 return $this->validate_all ? true : false;
         }

Here is the caller graph for this function:

◆ setCheckPeriod()

ilLinkChecker::setCheckPeriod ( $a_period )

Definition at line 39 of file class.ilLinkChecker.php.

         {
                 $this->period = $a_period;
         }

◆ setMailStatus()

ilLinkChecker::setMailStatus ( $a_status )

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

         {
                 $this->mail_status = (bool) $a_status;
         }

◆ setObjId()

ilLinkChecker::setObjId ( $a_page_id )

Definition at line 66 of file class.ilLinkChecker.php.

         {
                 return $this->page_id = $a_page_id;
         }

Field Documentation

◆ $db

ilLinkChecker::$db = null

Definition at line 14 of file class.ilLinkChecker.php.

Referenced by __construct().

◆ $invalid_links

ilLinkChecker::$invalid_links = array()

Definition at line 16 of file class.ilLinkChecker.php.

◆ $log_messages

ilLinkChecker::$log_messages = array()

Definition at line 15 of file class.ilLinkChecker.php.

◆ $mail_status

ilLinkChecker::$mail_status = false

Definition at line 19 of file class.ilLinkChecker.php.

Referenced by getMailStatus().

◆ $page_id

ilLinkChecker::$page_id = 0

Definition at line 20 of file class.ilLinkChecker.php.

Referenced by getObjId().

◆ $validate_all

ilLinkChecker::$validate_all = true

Definition at line 18 of file class.ilLinkChecker.php.

The documentation for this class was generated from the following file:

Services/LinkChecker/classes/class.ilLinkChecker.php

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __appendInvalidLink()

◆ __appendLogMessage()

◆ __checkNotify()

◆ __clearDBData()

◆ __clearInvalidLinks()

◆ __clearLogMessages()

◆ __fetchUserData()

◆ __getLinks()

◆ __getNotifyLinks()

◆ __getObjIdByPageId()

◆ __getTitle()

◆ __getType()

◆ __getWebResourceLinks()

◆ __isInvalid()

◆ __saveInDB()

◆ __sendMail()

◆ __setType()

◆ __txt()

◆ __validateLinks()

◆ checkLinks()

◆ checkWebResourceLinks()

◆ createPermanentLink()

◆ getCheckPeriod()

◆ getInvalidLinks()

◆ getInvalidLinksFromDB()

◆ getLastCheckTimestamp()

◆ getLogMessages()

◆ getMailStatus()

◆ getObjId()

◆ getValidateAll()

◆ setCheckPeriod()

◆ setMailStatus()

◆ setObjId()

Field Documentation

◆ $db

◆ $invalid_links

◆ $log_messages

◆ $mail_status

◆ $page_id

◆ $validate_all