ilCronPersonalWorkspaceRecalculateQuota Class Reference

Inheritance diagram for ilCronPersonalWorkspaceRecalculateQuota:

Collaboration diagram for ilCronPersonalWorkspaceRecalculateQuota:

Public Member Functions
	__construct ()
	Constructor. More...
	getId ()
	Get id. Returns string More...
	getTitle ()
	Get title. Returns string More...
	getDescription ()
	Get description. Returns string More...
	getDefaultScheduleType ()
	Get schedule type. Returns int More...
	getDefaultScheduleValue ()
	Get schedule value. Returns int|array More...
	hasAutoActivation ()
	Is to be activated on "installation". Returns boolean More...
	hasFlexibleSchedule ()
	Can the schedule be configured? Returns boolean More...
	hasCustomSettings ()
	Has cron job any custom setting which can be edited? Returns boolean More...
	run ()
	Run job. Returns ilCronJobResult More...
	recalculate ()
	Recalculate. More...
	quotaHandleFile ($a_obj_id, $a_owner_id)
	quotaHandleMob ($a_obj_id, $a_owner_id)
	quotaHandleFileStorage ($a_type, $a_obj_id, $a_owner_id, $a_dir)
	quotaHandleVerification ($a_type, $a_obj_id, $a_owner_id)
Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...
	getScheduleType ()
	Get current schedule type (if flexible) More...
	getScheduleValue ()
	Get current schedule value (if flexible) More...
	setSchedule ($a_type, $a_value)
	Update current schedule (if flexible) More...
	getAllScheduleTypes ()
	Get all available schedule types. More...
	getScheduleTypesWithValues ()
	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...
	getTitle ()
	Get title. More...
	getDescription ()
	Get description. More...
	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...
	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...
	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...
	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...
	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...
	getId ()
	Get id. More...
	hasAutoActivation ()
	Is to be activated on "installation". More...
	hasFlexibleSchedule ()
	Can the schedule be configured? More...
	getDefaultScheduleType ()
	Get schedule type. More...
	getDefaultScheduleValue ()
	Get schedule value. More...
	run ()
	Run job. More...

Protected Attributes
	$lng
	$db
	$job_status

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
const	SCHEDULE_TYPE_IN_MINUTES = 2
const	SCHEDULE_TYPE_IN_HOURS = 3
const	SCHEDULE_TYPE_IN_DAYS = 4
const	SCHEDULE_TYPE_WEEKLY = 5
const	SCHEDULE_TYPE_MONTHLY = 6
const	SCHEDULE_TYPE_QUARTERLY = 7
const	SCHEDULE_TYPE_YEARLY = 8
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilCronPersonalWorkspaceRecalculateQuota::__construct

(

)

Constructor.

Definition at line 34 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $ilDB = $DIC->database();
 
        $this->db = $ilDB;
    }

References $DIC, and $ilDB.

Member Function Documentation

getDefaultScheduleType()

ilCronPersonalWorkspaceRecalculateQuota::getDefaultScheduleType

(

)

Get schedule type.

Returns

int

Reimplemented from ilCronJob.

Definition at line 76 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

getDefaultScheduleValue()

ilCronPersonalWorkspaceRecalculateQuota::getDefaultScheduleValue

(

)

Get schedule value.

Returns

int|array

Reimplemented from ilCronJob.

Definition at line 84 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        return;
    }

getDescription()

ilCronPersonalWorkspaceRecalculateQuota::getDescription

(

)

Get description.

Returns

string

Reimplemented from ilCronJob.

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

    {
        $lng = $this->lng;
 
        return $lng->txt("pwsp_recalculate_disk_quota_desc");
    }

References $lng.

getId()

ilCronPersonalWorkspaceRecalculateQuota::getId

(

)

Get id.

Returns

string

Reimplemented from ilCronJob.

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

    {
        return "pwsp_recalc_quota";
    }

getTitle()

ilCronPersonalWorkspaceRecalculateQuota::getTitle

(

)

Get title.

Returns

string

Reimplemented from ilCronJob.

Definition at line 56 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        $lng = $this->lng;
        
        return $lng->txt("pwsp_recalculate_disk_quota");
    }

References $lng.

hasAutoActivation()

ilCronPersonalWorkspaceRecalculateQuota::hasAutoActivation

(

)

Is to be activated on "installation".

Returns

boolean

Reimplemented from ilCronJob.

Definition at line 92 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        return false;
    }

hasCustomSettings()

ilCronPersonalWorkspaceRecalculateQuota::hasCustomSettings

(

)

Has cron job any custom setting which can be edited?

Returns

boolean

Reimplemented from ilCronJob.

Definition at line 108 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        return true;
    }

hasFlexibleSchedule()

ilCronPersonalWorkspaceRecalculateQuota::hasFlexibleSchedule

(

)

Can the schedule be configured?

Returns

boolean

Reimplemented from ilCronJob.

Definition at line 100 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        return true;
    }

quotaHandleFile()

ilCronPersonalWorkspaceRecalculateQuota::quotaHandleFile	(		$a_obj_id,
			$a_owner_id
	)

Parameters

int	$a_obj_id
int	$a_owner_id

Definition at line 294 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        $ilDB = $this->db;
 
        // see ilFileSystemStorage::_createPathFromId()
        $tpath = array();
        $tfound = false;
        $tnum = $a_obj_id;
        for ($i = 3; $i > 0; $i--) {
            $factor = pow(100, $i);
            if (($tmp = (int) ($tnum / $factor)) or $tfound) {
                $tpath[] = $tmp;
                $tnum = $tnum % $factor;
                $tfound = true;
            }
        }
 
        $file_path = ilUtil::getDataDir() . "/ilFile/";
        if (count($tpath)) {
            $file_path .= (implode('/', $tpath) . '/');
        }
        $file_path .= "file_" . $a_obj_id;
        if (file_exists($file_path)) {
            $file_size = (int) ilUtil::dirsize($file_path);
            if ($file_size > 0) {
                $ilDB->manipulate("INSERT INTO il_disk_quota" .
                    " (owner_id, src_type, src_obj_id, src_size)" .
                    " VALUES (" . $ilDB->quote($a_owner_id, "integer") .
                    ", " . $ilDB->quote("file", "text") .
                    ", " . $ilDB->quote($a_obj_id, "integer") .
                    ", " . $ilDB->quote($file_size, "integer") . ")");
            }
        }
    }

References $db, $i, $ilDB, ilUtil\dirsize(), and ilUtil\getDataDir().

Referenced by recalculate().

Here is the call graph for this function:

Here is the caller graph for this function:

quotaHandleFileStorage()

ilCronPersonalWorkspaceRecalculateQuota::quotaHandleFileStorage	(		$a_type,
			$a_obj_id,
			$a_owner_id,
			$a_dir
	)

Parameters

string	$a_type
int	$a_obj_id
int	$a_owner_id
string	$a_dir

Definition at line 357 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        $ilDB = $this->db;
 
        // see ilFileSystemStorage::_createPathFromId()
        $tpath = array();
        $tfound = false;
        $tnum = $a_obj_id;
        for ($i = 3; $i > 0; $i--) {
            $factor = pow(100, $i);
            if (($tmp = (int) ($tnum / $factor)) or $tfound) {
                $tpath[] = $tmp;
                $tnum = $tnum % $factor;
                $tfound = true;
            }
        }
 
        $file_path = CLIENT_WEB_DIR . "/" . $a_dir . "/";
        if (count($tpath)) {
            $file_path .= (implode('/', $tpath) . '/');
        }
        $file_path .= $a_type . "_" . $a_obj_id;
 
        if (file_exists($file_path)) {
            $file_size = (int) ilUtil::dirsize($file_path);
            if ($file_size > 0) {
                $ilDB->manipulate("INSERT INTO il_disk_quota" .
                    " (owner_id, src_type, src_obj_id, src_size)" .
                    " VALUES (" . $ilDB->quote($a_owner_id, "integer") .
                    ", " . $ilDB->quote($a_type, "text") .
                    ", " . $ilDB->quote($a_obj_id, "integer") .
                    ", " . $ilDB->quote($file_size, "integer") . ")");
            }
        }
    }

References $a_type, $db, $i, $ilDB, and ilUtil\dirsize().

Referenced by recalculate().

Here is the call graph for this function:

Here is the caller graph for this function:

quotaHandleMob()

ilCronPersonalWorkspaceRecalculateQuota::quotaHandleMob	(		$a_obj_id,
			$a_owner_id
	)

Parameters

int	$a_obj_id
int	$a_owner_id

Definition at line 333 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        $ilDB = $this->db;
 
        $file_path = CLIENT_WEB_DIR . "/mobs/mm_" . $a_obj_id;
        if (file_exists($file_path)) {
            $file_size = (int) ilUtil::dirsize($file_path);
            if ($file_size > 0) {
                $ilDB->manipulate("INSERT INTO il_disk_quota" .
                    " (owner_id, src_type, src_obj_id, src_size)" .
                    " VALUES (" . $ilDB->quote($a_owner_id, "integer") .
                    ", " . $ilDB->quote("mob", "text") .
                    ", " . $ilDB->quote($a_obj_id, "integer") .
                    ", " . $ilDB->quote($file_size, "integer") . ")");
            }
        }
    }

References $db, $ilDB, and ilUtil\dirsize().

Referenced by recalculate().

Here is the call graph for this function:

Here is the caller graph for this function:

quotaHandleVerification()

ilCronPersonalWorkspaceRecalculateQuota::quotaHandleVerification	(		$a_type,
			$a_obj_id,
			$a_owner_id
	)

Parameters

strin	$a_type
int	$a_obj_id
int	$a_owner_id

Definition at line 398 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        $ilDB = $this->db;
 
        // see ilFileSystemStorage::_createPathFromId()
        $tpath = array();
        $tfound = false;
        $tnum = $a_obj_id;
        for ($i = 3; $i > 0;$i--) {
            $factor = pow(100, $i);
            if (($tmp = (int) ($tnum / $factor)) or $tfound) {
                $tpath[] = $tmp;
                $tnum = $tnum % $factor;
                $tfound = true;
            }
        }
 
        $file_path = ilUtil::getDataDir() . "/ilVerification/";
        if (count($tpath)) {
            $file_path .= (implode('/', $tpath) . '/');
        }
        $file_path .= "vrfc_" . $a_obj_id;
        if (file_exists($file_path)) {
            $file_size = (int) ilUtil::dirsize($file_path);
            if ($file_size > 0) {
                $ilDB->manipulate("INSERT INTO il_disk_quota" .
                    " (owner_id, src_type, src_obj_id, src_size)" .
                    " VALUES (" . $ilDB->quote($a_owner_id, "integer") .
                    ", " . $ilDB->quote($a_type, "text") .
                    ", " . $ilDB->quote($a_obj_id, "integer") .
                    ", " . $ilDB->quote($file_size, "integer") . ")");
            }
        }
    }

References $a_type, $db, $i, $ilDB, ilUtil\dirsize(), and ilUtil\getDataDir().

Referenced by recalculate().

Here is the call graph for this function:

Here is the caller graph for this function:

recalculate()

ilCronPersonalWorkspaceRecalculateQuota::recalculate

(

)

Recalculate.

Definition at line 132 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        $ilDB = $this->db;
 
        //
        // Files (workspace, blogs and portfolios)
        //
 
        $ilDB->manipulate("DELETE FROM il_disk_quota" .
            " WHERE src_type = " . $ilDB->quote("file", "text"));
 
        $quota_done = array();
 
        // get all workspace files
        $set = $ilDB->query("SELECT od.owner, od.obj_id" .
            " FROM object_data od" .
            " JOIN object_reference_ws ref ON (ref.obj_id = od.obj_id)" .
            " JOIN tree_workspace t ON (t.child = ref.wsp_id)" .
            " WHERE od.type = " . $ilDB->quote("file", "text") .
            " AND t.tree = od.owner");
        while ($row = $ilDB->fetchAssoc($set)) {
            $id = $row["owner"] . "-" . $row["obj_id"];
            if (!in_array($id, $quota_done)) {
                $this->quotaHandleFile($row["obj_id"], $row["owner"]);
                $quota_done[] = $id;
            }
        }
 
        // get all file usage for workspace blogs
        $set = $ilDB->query("SELECT od.owner, fu.id" .
            " FROM object_data od" .
            " JOIN object_reference_ws ref ON (ref.obj_id = od.obj_id)" .
            " JOIN tree_workspace t ON (t.child = ref.wsp_id)" .
            " JOIN il_blog_posting blp ON (blp.blog_id = od.obj_id)" .
            " JOIN file_usage fu ON (fu.usage_id = blp.id)" .
            " WHERE fu.usage_type = " . $ilDB->quote("blp:pg", "text") .
            " AND fu.usage_hist_nr = " . $ilDB->quote(0, "integer"));
        while ($row = $ilDB->fetchAssoc($set)) {
            $id = $row["owner"] . "-" . $row["id"];
            if (!in_array($id, $quota_done)) {
                $this->quotaHandleFile($row["id"], $row["owner"]);
                $quota_done[] = $id;
            }
        }
 
        // get all file usage for portfolios
        $set = $ilDB->query($q = "SELECT od.owner, fu.id" .
            " FROM object_data od" .
            " JOIN usr_portfolio_page prtf ON (prtf.portfolio_id = od.obj_id)" .
            " JOIN file_usage fu ON (fu.usage_id = prtf.id)" .
            " WHERE fu.usage_type = " . $ilDB->quote("prtf:pg", "text") .
            " AND fu.usage_hist_nr = " . $ilDB->quote(0, "integer"));
 
        while ($row = $ilDB->fetchAssoc($set)) {
            $id = $row["owner"] . "-" . $row["id"];
            if (!in_array($id, $quota_done)) {
                $this->quotaHandleFile($row["id"], $row["owner"]);
                $quota_done[] = $id;
            }
        }
 
 
        //
        // Media objects (blogs and portfolios)
        //
 
        $ilDB->manipulate("DELETE FROM il_disk_quota" .
            " WHERE src_type = " . $ilDB->quote("mob", "text"));
 
        $quota_done = array();
 
        // get all mob usage for workspace blogs
        $set = $ilDB->query("SELECT od.owner, mu.id" .
            " FROM object_data od" .
            " JOIN object_reference_ws ref ON (ref.obj_id = od.obj_id)" .
            " JOIN tree_workspace t ON (t.child = ref.wsp_id)" .
            " JOIN il_blog_posting blp ON (blp.blog_id = od.obj_id)" .
            " JOIN mob_usage mu ON (mu.usage_id = blp.id)" .
            " WHERE mu.usage_type = " . $ilDB->quote("blp:pg", "text") .
            " AND mu.usage_hist_nr = " . $ilDB->quote(0, "integer"));
        while ($row = $ilDB->fetchAssoc($set)) {
            $id = $row["owner"] . "-" . $row["id"];
            if (!in_array($id, $quota_done)) {
                $this->quotaHandleMob($row["id"], $row["owner"]);
                $quota_done[] = $id;
            }
        }
 
        // get all mob usage for portfolios
        $set = $ilDB->query("SELECT od.owner, mu.id" .
            " FROM object_data od" .
            " JOIN usr_portfolio_page prtf ON (prtf.portfolio_id = od.obj_id)" .
            " JOIN mob_usage mu ON (mu.usage_id = prtf.id)" .
            " WHERE mu.usage_type = " . $ilDB->quote("prtf:pg", "text") .
            " AND mu.usage_hist_nr = " . $ilDB->quote(0, "integer"));
        while ($row = $ilDB->fetchAssoc($set)) {
            $id = $row["owner"] . "-" . $row["id"];
            if (!in_array($id, $quota_done)) {
                $this->quotaHandleMob($row["id"], $row["owner"]);
                $quota_done[] = $id;
            }
        }
 
        //
        // Portfolio / Blog images
        //
 
        $ilDB->manipulate("DELETE FROM il_disk_quota" .
            " WHERE src_type = " . $ilDB->quote("prtf", "text"));
        $ilDB->manipulate("DELETE FROM il_disk_quota" .
            " WHERE src_type = " . $ilDB->quote("blog", "text"));
 
        // portfolios
        $set = $ilDB->query("SELECT od.owner, od.obj_id" .
            " FROM object_data od" .
            " JOIN usr_portfolio prtf ON (prtf.id = od.obj_id)" .
            " WHERE od.type = " . $ilDB->quote("prtf", "text") .
            " AND prtf.img IS NOT NULL");
        while ($row = $ilDB->fetchAssoc($set)) {
            $this->quotaHandleFileStorage("prtf", $row["obj_id"], $row["owner"], "sec/ilPortfolio");
        }
 
        // (workspace) blogs
        $set = $ilDB->query("SELECT od.owner, od.obj_id" .
            " FROM object_data od" .
            " JOIN object_reference_ws ref ON (ref.obj_id = od.obj_id)" .
            " JOIN tree_workspace t ON (t.child = ref.wsp_id)" .
            " JOIN il_blog blog ON (blog.id = od.obj_id)" .
            " WHERE od.type = " . $ilDB->quote("blog", "text") .
            " AND blog.img IS NOT NULL" .
            " AND t.tree = od.owner");
        while ($row = $ilDB->fetchAssoc($set)) {
            $this->quotaHandleFileStorage("blog", $row["obj_id"], $row["owner"], "sec/ilBlog");
        }
 
        return;
 
        //
        // Verifications
        //
 
        $ilDB->manipulate("DELETE FROM il_disk_quota" .
            " WHERE src_type = " . $ilDB->quote("tstv", "text"));
        $ilDB->manipulate("DELETE FROM il_disk_quota" .
            " WHERE src_type = " . $ilDB->quote("excv", "text"));
 
        // (workspace) verifications
        $set = $ilDB->query("SELECT od.owner, od.obj_id, od.type" .
            " FROM object_data od" .
            " JOIN object_reference_ws ref ON (ref.obj_id = od.obj_id)" .
            " JOIN tree_workspace t ON (t.child = ref.wsp_id)" .
            " WHERE " . $ilDB->in("od.type", array("tstv", "excv"), "", "text") .
            " AND t.tree = od.owner");
        while ($row = $ilDB->fetchAssoc($set)) {
            $this->quotaHandleVerification($row["type"], $row["obj_id"], $row["owner"]);
        }
    }

References $db, $ilDB, quotaHandleFile(), quotaHandleFileStorage(), quotaHandleMob(), and quotaHandleVerification().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

run()

ilCronPersonalWorkspaceRecalculateQuota::run

(

)

Run job.

Returns

ilCronJobResult

Reimplemented from ilCronJob.

Definition at line 116 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

    {
        $this->job_status = ilCronJobResult::STATUS_NO_ACTION;
 
        $this->recalculate();
 
        $this->job_status = ilCronJobResult::STATUS_OK;
 
        $result = new ilCronJobResult();
        $result->setStatus($this->job_status);
        return $result;
    }

References $result, recalculate(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

Here is the call graph for this function:

Field Documentation

$db

ilCronPersonalWorkspaceRecalculateQuota::$db

protected

Definition at line 24 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

Referenced by quotaHandleFile(), quotaHandleFileStorage(), quotaHandleMob(), quotaHandleVerification(), and recalculate().

$job_status

ilCronPersonalWorkspaceRecalculateQuota::$job_status

protected

Definition at line 29 of file class.ilCronPersonalWorkspaceRecalculateQuota.php.

$lng

ilCronPersonalWorkspaceRecalculateQuota::$lng

protected

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

Referenced by getDescription(), and getTitle().

---

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

• Services/PersonalWorkspace/classes/class.ilCronPersonalWorkspaceRecalculateQuota.php