class.ilCertificate.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2011 ILIAS open source, Extended GPL, see docs/LICENSE */


class ilCertificate
{
    protected $ctrl;

    protected $tree;

    protected $ilias;

    protected $lng;

    protected $adapter;

    protected $settings;

    protected $log;

    protected $db;

    protected static $is_active;

    private $templateRepository;

    private $placeholderDescriptionObject;

    private $objectId;

    private $certificateRepository;

    private $certificatePath;

    private $placeholderValuesObject;

    public function __construct(
        ilCertificateAdapter $adapter,
        ilCertificatePlaceholderDescription $placeholderDescriptionObject,
        ilCertificatePlaceholderValues $placeholderValuesObject,
        $objectId,
        $certificatePath,
        ilCertificateTemplateRepository $templateRepository = null,
        ilUserCertificateRepository $certificateRepository = null
    ) {
        global $DIC;

        $this->lng = $DIC['lng'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->ilias = $DIC['ilias'];
        $this->tree = $DIC['tree'];
        $this->settings = $DIC['ilSetting'];
        $this->log = $DIC['ilLog'];
        $this->db = $DIC['ilDB'];

        $this->adapter = $adapter;

        $this->placeholderDescriptionObject = $placeholderDescriptionObject;

        $this->placeholderValuesObject = $placeholderValuesObject;

        $this->objectId = $objectId;

        $this->certificatePath = $certificatePath;

        $logger = $DIC->logger()->cert();

        if ($templateRepository === null) {
            $templateRepository = new ilCertificateTemplateRepository($DIC->database(), $logger);
        }
        $this->templateRepository = $templateRepository;

        if ($certificateRepository === null) {
            $certificateRepository = new ilUserCertificateRepository($DIC->database(), $logger);
        }
        $this->certificateRepository = $certificateRepository;
    }

    public function getBackgroundImageDirectory($asRelative = false, $backgroundImagePath = '')
    {
        if ($asRelative) {
            return str_replace(
                array(CLIENT_WEB_DIR, '//'),
                array('[CLIENT_WEB_DIR]', '/'),
                $backgroundImagePath
            );
        }

        return $this->certificatePath;
    }

    public function getBackgroundImageName()
    {
        return "background.jpg";
    }

    public function getBackgroundImageThumbPath()
    {
        return CLIENT_WEB_DIR . $this->certificatePath . $this->getBackgroundImageName() . ".thumb.jpg";
    }

    public function getBackgroundImageTempfilePath()
    {
        return CLIENT_WEB_DIR . $this->certificatePath . "background_upload.tmp";
    }

    public function getXSLPath()
    {
        return CLIENT_WEB_DIR . $this->certificatePath . $this->getXSLName();
    }

    public function getXSLName()
    {
        return "certificate.xml";
    }

    public static function _getXSLName()
    {
        return "certificate.xml";
    }

    public function getBackgroundImagePathWeb()
    {
        // TODO: this is generic now -> provide better solution
        $webdir = $this->certificatePath . $this->getBackgroundImageName();

        return str_replace(
            ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH),
            ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH),
            $webdir
        );
    }

    public function getBackgroundImageThumbPathWeb()
    {
        // TODO: this is generic now -> provide better solution
        return str_replace(
            ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH),
            ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH),
            $this->getBackgroundImageThumbPath()
        );
    }

    public function deleteBackgroundImage($version)
    {
        $result = true;
        if (file_exists($this->getBackgroundImageThumbPath())) {
            $result = $result & unlink($this->getBackgroundImageThumbPath());
        }

        $filename = $this->getBackgroundImageDirectory() . 'background_' . $version . '.jpg';
        if (file_exists($filename)) {
            $result = $result & unlink($filename);
        }

        if (file_exists($this->getBackgroundImageTempfilePath())) {
            $result = $result & unlink($this->getBackgroundImageTempfilePath());
        }

        return $result;
    }

    public function createCertificateFile($xslfo, $filename = '')
    {
        if (!file_exists($this->certificatePath)) {
            ilUtil::makeDirParents($this->certificatePath);
        }

        if (strlen($filename) == 0) {
            $filename = $this->getXSLPath();
        }

        $fileHandle = fopen($filename, "w");
        fwrite($fileHandle, $xslfo);
        fclose($fileHandle);
    }

    public function hasBackgroundImage()
    {
        $template = $this->templateRepository->fetchCurrentlyUsedCertificate($this->objectId);

        $backgroundImagePath = $template->getBackgroundImagePath();
        if ($backgroundImagePath === '') {
            return false;
        }

        $absolutePath = CLIENT_WEB_DIR . $backgroundImagePath;
        
        if (file_exists($absolutePath)
            && (filesize($absolutePath) > 0)
        ) {
            return true;
        }
        return false;
    }

    public function isComplete()
    {
        if (self::isActive()) {
            if ($this->objectId && !self::isObjectActive($this->objectId)) {
                return false;
            }

            return true;
        }

        return false;
    }

    public function getAdapter()
    {
        return $this->adapter;
    }

    public function setAdapter($adapter)
    {
        $this->adapter = &$adapter;
    }

    /***************************************
    /* BULK CERTIFICATE PROCESSING METHODS *
    /***************************************

    public function createArchiveDirectory()
    {
        $type = ilObject::_lookupType($this->objectId);
        $certificateId = $this->objectId;

        $dir = CLIENT_WEB_DIR . $this->certificatePath . time() . "__" . IL_INST_ID . "__" . $type . "__" . $certificateId . "__certificate/";
        ilUtil::makeDirParents($dir);
        return $dir;
    }

    public function addPDFtoArchiveDirectory($pdfdata, $dir, $filename)
    {
        $fh = fopen($dir . $filename, "wb");
        fwrite($fh, $pdfdata);
        fclose($fh);
    }

    public function zipCertificatesInArchiveDirectory($dir, $deliver = true)
    {
        $zipfile = time() . "__" . IL_INST_ID . "__" . $this->getAdapter()->getAdapterType() . "__" . $this->getAdapter()->getCertificateId() . "__certificates.zip";
        $zipfilePath = CLIENT_WEB_DIR . $this->certificatePath . $zipfile;
        ilUtil::zip($dir, $zipfilePath);
        ilUtil::delDir($dir);
        if ($deliver) {
            ilUtil::deliverFile($zipfilePath, $zipfile, "application/zip", false, true);
        }
        return $zipfilePath;
    }

    public static function isActive()
    {
        if (self::$is_active === null) {
            // basic admin setting active?
            $certificate_active = new ilSetting("certificate");
            $certificate_active = (bool) $certificate_active->get("active");

            // java/rtpc-server active?
            if ($certificate_active) {
                include_once './Services/WebServices/RPC/classes/class.ilRPCServerSettings.php';
                $certificate_active = ilRPCServerSettings::getInstance()->isEnabled();
            }

            self::$is_active = (bool) $certificate_active;
        }

        return self::$is_active;
    }

    public static function isObjectActive($a_obj_id)
    {
        $chk = self::areObjectsActive(array($a_obj_id));
        return $chk[$a_obj_id];
    }

    public static function areObjectsActive(array $a_obj_ids)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $all = array();
        foreach ($a_obj_ids as $id) {
            $all[$id] = false;
        }

        $set = $ilDB->query("SELECT obj_id FROM il_certificate WHERE " . $ilDB->in("obj_id", $a_obj_ids, "", "integer"));
        while ($row = $ilDB->fetchAssoc($set)) {
            $all[$row["obj_id"]] = true;
        }

        return $all;
    }

    public function readActive()
    {
        $set = $this->db->query("SELECT obj_id FROM il_certificate WHERE obj_id = " . $this->db->quote($this->objectId, "integer"));
        return $this->db->numRows($set);
    }
}