Class manages user html export. More...

Collaboration diagram for ilWikiUserHTMLExport:

Public Member Functions
	__construct (ilObjWiki $a_wiki, ilDBInterface $a_db, ilObjUser $a_user, $with_comments=false)
	Construct. More...

	updateStatus ($a_progress, $a_status)
	Update status. More...

	getProgress ()
	Get Progress. More...

	initUserHTMLExport ()
	Init user html export. More...

	startUserHTMLExport ()
	Start user html export. More...

	deliverFile ()
	Deliver file. More...

Data Fields
const	PROCESS_OTHER_USER = 0

const	PROCESS_STARTED = 1

const	PROCESS_UPTODATE = 2

const	NOT_RUNNING = 0

const	RUNNING = 1

Protected Member Functions
	read ()
	Read. More...

	getProcess ()
	Get process. More...

	doesFileExist ()
	Does file exist? More...

Protected Attributes
	$data

	$db

	$wiki

	$user

	$log

	$with_comments = false

Detailed Description

Class manages user html export.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilWikiUserHTMLExport::__construct	(	ilObjWiki	$a_wiki,
		ilDBInterface	$a_db,
		ilObjUser	$a_user,
			$with_comments = `false`
	)

Construct.

Parameters

Definition at line 55 of file class.ilWikiUserHTMLExport.php.

References $with_comments, ilLoggerFactory\getLogger(), read(), and user().

     {
         $this->db = $a_db;
         $this->wiki = $a_wiki;
         $this->user = $a_user;
         $this->read();
         $this->log = ilLoggerFactory::getLogger('wiki');
         $this->with_comments = $with_comments;
         $this->log->debug("comments: " . $this->with_comments);
     }

Here is the call graph for this function:

Member Function Documentation

◆ deliverFile()

ilWikiUserHTMLExport::deliverFile ( )

Deliver file.

Definition at line 250 of file class.ilWikiUserHTMLExport.php.

References ilUtil\deliverFile().

     {
         $this->log->debug("deliver");
 
         $exp = new WikiHtmlExport($this->wiki);
         if ($this->with_comments) {
             $exp->setMode(WikiHtmlExport::MODE_USER_COMMENTS);
         } else {
             $exp->setMode(WikiHtmlExport::MODE_USER);
         }
         $file = $exp->getUserExportFile();
         $this->log->debug("file: " . $file);
         ilUtil::deliverFile($file, pathinfo($file, PATHINFO_BASENAME));
     }

Here is the call graph for this function:

◆ doesFileExist()

ilWikiUserHTMLExport::doesFileExist ( )

protected

Does file exist?

Definition at line 235 of file class.ilWikiUserHTMLExport.php.

Referenced by getProcess().

     {
         $exp = new WikiHtmlExport($this->wiki);
         if ($this->with_comments) {
             $exp->setMode(WikiHtmlExport::MODE_USER_COMMENTS);
         } else {
             $exp->setMode(WikiHtmlExport::MODE_USER);
         }
         $file = $exp->getUserExportFile();
         return is_file($file);
     }

Here is the caller graph for this function:

◆ getProcess()

ilWikiUserHTMLExport::getProcess ( )

protected

Get process.

Parameters

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

References $ilDB, $ret, $with_comments, doesFileExist(), ilPageObject\getLastChangeByParent(), ilDBInterface\manipulate(), ilUtil\now(), ilDBInterface\quote(), read(), and user().

Referenced by initUserHTMLExport().

     {
         $this->log->debug("getProcess");
         $last_change = ilPageObject::getLastChangeByParent("wpg", $this->wiki->getId());
         $file_exists = $this->doesFileExist();
 
         $ilAtomQuery = $this->db->buildAtomQuery();
         $ilAtomQuery->addTableLock('wiki_user_html_export');
 
         $ilAtomQuery->addQueryCallable(function (ilDBInterface $ilDB) use ($last_change, &$ret, $file_exists) {
             $this->log->debug("atom query start");
             
             $this->read();
             $ts = ilUtil::now();
 
             if ($this->data["start_ts"] != "" &&
                 $this->data["start_ts"] > $last_change) {
                 if ($file_exists) {
                     $ret = self::PROCESS_UPTODATE;
                     $this->log->debug("return: " . self::PROCESS_UPTODATE);
                     return;
                 }
             }
 
             if (!isset($this->data["wiki_id"])) {
                 $this->log->debug("insert, wiki id: " . $this->wiki->getId() . ", user id: " . $this->user->getId() .
                     ", ts: " . $ts . ", with_comments: " . $this->with_comments);
                 $ilDB->manipulate("INSERT INTO wiki_user_html_export  " .
                     "(wiki_id, usr_id, progress, start_ts, status, with_comments) VALUES (" .
                     $ilDB->quote($this->wiki->getId(), "integer") . "," .
                     $ilDB->quote($this->user->getId(), "integer") . "," .
                     $ilDB->quote(0, "integer") . "," .
                     $ilDB->quote($ts, "timestamp") . "," .
                     $ilDB->quote(self::RUNNING, "integer") . "," .
                     $ilDB->quote($this->with_comments, "integer") .
                     ")");
             } else {
                 $this->log->debug("update, wiki id: " . $this->wiki->getId() . ", user id: " . $this->user->getId() .
                     ", ts: " . $ts . ", with_comments: " . $this->with_comments);
                 $ilDB->manipulate(
                     "UPDATE wiki_user_html_export SET " .
                     " start_ts = " . $ilDB->quote($ts, "timestamp") . "," .
                     " usr_id = " . $ilDB->quote($this->user->getId(), "integer") . "," .
                     " progress = " . $ilDB->quote(0, "integer") . "," .
                     " status = " . $ilDB->quote(self::RUNNING, "integer") .
                     " WHERE status = " . $ilDB->quote(self::NOT_RUNNING, "integer") .
                     " AND wiki_id = " . $ilDB->quote($this->wiki->getId(), "integer") .
                     " AND with_comments = " . $ilDB->quote($this->with_comments, "integer")
                 );
                 $this->read();
             }
 
             if ($this->data["start_ts"] == $ts && $this->data["usr_id"] == $this->user->getId()) {
                 //  we started the process
                 $ret = self::PROCESS_STARTED;
                 $this->log->debug("return: " . self::PROCESS_STARTED);
                 return;
             }
 
             // process was already running
             $ret = self::PROCESS_OTHER_USER;
             $this->log->debug("return: " . self::PROCESS_OTHER_USER);
         });
 
         $ilAtomQuery->run();
 
         $this->log->debug("outer return: " . $ret);
 
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgress()

ilWikiUserHTMLExport::getProgress ( )

Get Progress.

Parameters

Definition at line 187 of file class.ilWikiUserHTMLExport.php.

     {
         $set = $this->db->query(
             "SELECT progress, status FROM wiki_user_html_export " .
             " WHERE wiki_id = " . $this->db->quote($this->wiki->getId(), "integer") .
             " AND with_comments = " . $this->db->quote($this->with_comments, "integer")
         );
         $rec = $this->db->fetchAssoc($set);
 
         return array("progress" => (int) $rec["progress"], "status" => (int) $rec["status"]);
     }

◆ initUserHTMLExport()

ilWikiUserHTMLExport::initUserHTMLExport ( )

Init user html export.

Parameters

Definition at line 206 of file class.ilWikiUserHTMLExport.php.

References exit, and getProcess().

     {
         // get process, if not already running or export is up-to-date, return corresponding status
         echo $this->getProcess();
         exit;
     }

Here is the call graph for this function:

◆ read()

ilWikiUserHTMLExport::read ( )

protected

Read.

Parameters

Definition at line 72 of file class.ilWikiUserHTMLExport.php.

Referenced by __construct(), getProcess(), and updateStatus().

     {
         $set = $this->db->query(
             "SELECT * FROM wiki_user_html_export " .
             " WHERE wiki_id  = " . $this->db->quote($this->wiki->getId(), "integer") .
             " AND with_comments = " . $this->db->quote($this->with_comments, "integer")
         );
         if (!$this->data = $this->db->fetchAssoc($set)) {
             $this->data = array();
         }
     }

Here is the caller graph for this function:

◆ startUserHTMLExport()

ilWikiUserHTMLExport::startUserHTMLExport ( )

Start user html export.

Definition at line 216 of file class.ilWikiUserHTMLExport.php.

References exit, and updateStatus().

     {
         ignore_user_abort(true);
         // do the export
         $exp = new WikiHtmlExport($this->wiki);
         if (!$this->with_comments) {
             $exp->setMode(WikiHtmlExport::MODE_USER);
         } else {
             $exp->setMode(WikiHtmlExport::MODE_USER_COMMENTS);
         }
         $exp->buildExportFile();
         // reset user export status
         $this->updateStatus(100, self::NOT_RUNNING);
         exit;
     }

Here is the call graph for this function:

◆ updateStatus()

ilWikiUserHTMLExport::updateStatus	(	$a_progress,
		$a_status
	)

Update status.

Parameters

Definition at line 167 of file class.ilWikiUserHTMLExport.php.

References read().

Referenced by startUserHTMLExport().

     {
         $this->db->manipulate(
             "UPDATE wiki_user_html_export SET " .
             " progress = " . $this->db->quote((int) $a_progress, "integer") . "," .
             " status = " . $this->db->quote((int) $a_status, "integer") .
             " WHERE wiki_id = " . $this->db->quote($this->wiki->getId(), "integer") .
             " AND usr_id = " . $this->db->quote($this->user->getId(), "integer") .
             " AND with_comments = " . $this->db->quote($this->with_comments, "integer")
         );
 
         $this->read();
     }