Class manages user html export. More...

Collaboration diagram for ilWikiUserHTMLExport:

Public Member Functions
	__construct (ilObjWiki $a_wiki, ilDBInterface $a_db, ilObjUser $a_user)
	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...

Protected Attributes
	$data

	$db

	$wiki

	$user

	$log

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilWikiUserHTMLExport::__construct	(	ilObjWiki	$a_wiki,
		ilDBInterface	$a_db,
		ilObjUser	$a_user
	)

Construct.

Parameters

return

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ deliverFile()

ilWikiUserHTMLExport::deliverFile ( )

Deliver file.

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

    {
        $this->log->debug("deliver");
        include_once("./Modules/Wiki/classes/class.ilWikiHTMLExport.php");
        $exp = new ilWikiHTMLExport($this->wiki);
        $exp->setMode(ilWikiHTMLExport::MODE_USER);
        $file = $exp->getUserExportFile();
        $this->log->debug("file: " . $file);
        ilUtil::deliverFile($file, pathinfo($file, PATHINFO_BASENAME));
    }

References $file, ilUtil\deliverFile(), and ilWikiHTMLExport\MODE_USER.

Here is the call graph for this function:

◆ getProcess()

ilWikiUserHTMLExport::getProcess ( )

protected

Get process.

Parameters

return

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

    {
        $this->log->debug("getProcess");
        $last_change = ilPageObject::getLastChangeByParent("wpg", $this->wiki->getId());
 
        $ilAtomQuery = $this->db->buildAtomQuery();
        $ilAtomQuery->addTableLock('wiki_user_html_export');
 
        $ilAtomQuery->addQueryCallable(function (ilDBInterface $ilDB) use ($last_change, &$ret) {
            $this->log->debug("atom query start");
            
            $this->read();
            $ts = ilUtil::now();
 
            if ($this->data["start_ts"] != "" &&
                $this->data["start_ts"] > $last_change) {
                $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);
                $ilDB->manipulate("INSERT INTO wiki_user_html_export  " .
                    "(wiki_id, usr_id, progress, start_ts, status) 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") .
                    ")");
            } else {
                $this->log->debug("update, wiki id: " . $this->wiki->getId() . ", user id: " . $this->user->getId() . ", ts: " . $ts);
                $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")
                );
                $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;
    }

References $ilDB, $ret, data, ilPageObject\getLastChangeByParent(), ilUtil\now(), PROCESS_OTHER_USER, PROCESS_STARTED, PROCESS_UPTODATE, read(), and user().

Referenced by initUserHTMLExport().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgress()

ilWikiUserHTMLExport::getProgress ( )

Get Progress.

Parameters

return

Definition at line 171 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")
        );
        $rec = $this->db->fetchAssoc($set);
 
        return array("progress" => (int) $rec["progress"], "status" => (int) $rec["status"]);
    }

◆ initUserHTMLExport()

ilWikiUserHTMLExport::initUserHTMLExport ( )

Init user html export.

Parameters

return

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

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

References exit, and getProcess().

Here is the call graph for this function:

◆ read()

ilWikiUserHTMLExport::read ( )

protected

Read.

Parameters

return

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

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

References data.

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

Here is the caller graph for this function:

◆ startUserHTMLExport()

ilWikiUserHTMLExport::startUserHTMLExport ( )

Start user html export.

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

    {
        ignore_user_abort(true);
        // do the export
        include_once("./Modules/Wiki/classes/class.ilWikiHTMLExport.php");
        $exp = new ilWikiHTMLExport($this->wiki);
        $exp->setMode(ilWikiHTMLExport::MODE_USER);
        $exp->buildExportFile();
        // reset user export status
        $this->updateStatus(100, self::NOT_RUNNING);
        exit;
    }

References exit, ilWikiHTMLExport\MODE_USER, and updateStatus().

Here is the call graph for this function:

◆ updateStatus()

ilWikiUserHTMLExport::updateStatus	(	$a_progress,
		$a_status
	)

Update status.

Parameters

return

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

    {
        $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")
        );
 
        $this->read();
    }