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 $tpl;

        protected $lng;

        protected $adapter;
        
        protected static $is_active;
        
        function __construct($adapter)
        {
                global $lng, $tpl, $ilCtrl, $ilias, $tree;

                $this->lng =& $lng;
                $this->tpl =& $tpl;
                $this->ctrl =& $ilCtrl;
                $this->ilias =& $ilias;
                $this->tree =& $tree;
                $this->adapter =& $adapter;
        }
        
        public function getBackgroundImagePath()
        {
                return $this->getAdapter()->getCertificatePath() . $this->getBackgroundImageName();
        }

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

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

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

        public function getXSLPath()
        {
                return $this->getAdapter()->getCertificatePath() . $this->getXSLName();
        }
        
        function getXSLName()
        {
                return "certificate.xml";
        }
        
        public static function _getXSLName()
        {
                return "certificate.xml";
        }
        
        public function getBackgroundImagePathWeb()
        {
                // TODO: this is generic now -> provide better solution
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                $webdir = $this->getAdapter()->getCertificatePath() . $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
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                return str_replace(ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH), ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH), $this->getBackgroundImageThumbPath());
        }
        
        public function deleteBackgroundImage()
        {
                $result = TRUE;
                if (file_exists($this->getBackgroundImageThumbPath()))
                {
                        $result = $result & unlink($this->getBackgroundImageThumbPath());
                }
                if (file_exists($this->getBackgroundImagePath()))
                {
                        $result = $result & unlink($this->getBackgroundImagePath());
                }
                if (file_exists($this->getBackgroundImageTempfilePath()))
                {
                        $result = $result & unlink($this->getBackgroundImageTempfilePath());
                }
                return $result;
        }

        public function cloneCertificate($newObject)
        {
                $xsl = $this->getXSLPath();
                $bgimage = $this->getBackgroundImagePath();
                $bgimagethumb = $this->getBackgroundImageThumbPath();
                $certificatepath = $this->getAdapter()->getCertificatePath();
                
                $new_xsl = $newObject->getXSLPath();
                $new_bgimage = $newObject->getBackgroundImagePath();
                $new_bgimagethumb = $newObject->getBackgroundImageThumbPath();
                $new_certificatepath = $newObject->getAdapter()->getCertificatePath();
                
                if (@file_exists($xsl))
                {
                        ilUtil::makeDirParents($new_certificatepath);
                        @copy($xsl, $new_xsl);
                        if (@file_exists($bgimage)) @copy($bgimage, $new_bgimage);
                        if (@file_exists($bgimagethumb)) @copy($bgimagethumb, $new_bgimagethumb);
                }
                
                // #10271
                if($this->readActive())
                {
                        $newObject->writeActive(true);
                }
        }

        public function deleteCertificate()
        {
                if (@file_exists($this->getAdapter()->getCertificatePath()))
                {
                        include_once "./Services/Utilities/classes/class.ilUtil.php";
                        ilUtil::delDir($this->getAdapter()->getCertificatePath());
                        $this->getAdapter()->deleteCertificate();
                }
                $this->writeActive(false);
        }
        
        public function getFormFieldsFromFO()
        {
                if (@file_exists($this->getXSLPath()))
                {
                        $xslfo = file_get_contents($this->getXSLPath());
                }
                // retrieve form information (using a dirty way with regular expressions)
                $pagewidth = "21cm";
                if (preg_match("/page-width\=\"([^\"]+)\"/", $xslfo, $matches))
                {
                        $pagewidth = $matches[1];
                }
                $pageheight = "29.7cm";
                if (preg_match("/page-height\=\"([^\"]+)\"/", $xslfo, $matches))
                {
                        $pageheight = $matches[1];
                }
                $certificatesettings = new ilSetting("certificate");
                $pagesize = $certificatesettings->get("pageformat");;
                if (((strcmp($pageheight, "29.7cm") == 0) || (strcmp($pageheight, "297mm") == 0)) && ((strcmp($pagewidth, "21cm") == 0) || (strcmp($pagewidth, "210mm") == 0)))
                {
                        $pagesize = "a4";
                }
                else if (((strcmp($pagewidth, "29.7cm") == 0) || (strcmp($pagewidth, "297mm") == 0)) && ((strcmp($pageheight, "21cm") == 0) || (strcmp($pageheight, "210mm") == 0)))
                {
                        $pagesize = "a4landscape";
                }
                else if (((strcmp($pageheight, "21cm") == 0) || (strcmp($pageheight, "210mm") == 0)) && ((strcmp($pagewidth, "14.8cm") == 0) || (strcmp($pagewidth, "148mm") == 0)))
                {
                        $pagesize = "a5";
                }
                else if (((strcmp($pagewidth, "21cm") == 0) || (strcmp($pagewidth, "210mm") == 0)) && ((strcmp($pageheight, "14.8cm") == 0) || (strcmp($pageheight, "148mm") == 0)))
                {
                        $pagesize = "a5landscape";
                }
                else if (((strcmp($pageheight, "11in") == 0)) && ((strcmp($pagewidth, "8.5in") == 0)))
                {
                        $pagesize = "letter";
                }
                else if (((strcmp($pagewidth, "11in") == 0)) && ((strcmp($pageheight, "8.5in") == 0)))
                {
                        $pagesize = "letterlandscape";
                }
                else
                {
                        $pagesize = "custom";
                }
                if (!strlen($xslfo)) $pagesize = $certificatesettings->get("pageformat");;
                
                $marginbody_top = "0cm";
                $marginbody_right = "2cm";
                $marginbody_bottom = "0cm";
                $marginbody_left = "2cm";
                if(preg_match("/fo:flow[^>]*margin\=\"([^\"]+)\"/", $xslfo, $matches))
                {
                        // Backwards compatibility
                        $marginbody = $matches[1];
                        if (preg_match_all("/([^\s]+)/", $marginbody, $matches))
                        {
                                $marginbody_top = $matches[1][0];
                                $marginbody_right = $matches[1][1];
                                $marginbody_bottom = $matches[1][2];
                                $marginbody_left = $matches[1][3];
                        }
                }
                else if(preg_match("/fo:region-body[^>]*margin\=\"([^\"]+)\"/", $xslfo, $matches))
                {
                        $marginbody = $matches[1];
                        if (preg_match_all("/([^\s]+)/", $marginbody, $matches))
                        {
                                $marginbody_top = $matches[1][0];
                                $marginbody_right = $matches[1][1];
                                $marginbody_bottom = $matches[1][2];
                                $marginbody_left = $matches[1][3];
                        }
                }

                $xsl = file_get_contents("./Services/Certificate/xml/fo2xhtml.xsl");
                if ((strlen($xslfo)) && (strlen($xsl)))
                {
                        $args = array( '/_xml' => $xslfo, '/_xsl' => $xsl );
                        $xh = xslt_create();
                        $output = xslt_process($xh, "arg:/_xml", "arg:/_xsl", NULL, $args, NULL);
                        xslt_error($xh);
                        xslt_free($xh);
                }

                $output = preg_replace("/<\?xml[^>]+?>/", "", $output);
                // dirty hack: the php xslt processing seems not to recognize the following
                // replacements, so we do it in the code as well
                $output = str_replace("&#xA0;", "<br />", $output);
                $output = str_replace("&#160;", "<br />", $output);
                $form_fields = array(
                        "pageformat" => $pagesize,
                        "pagewidth" => $pagewidth,
                        "pageheight" => $pageheight,
                        "margin_body_top" => $marginbody_top,
                        "margin_body_right" => $marginbody_right,
                        "margin_body_bottom" => $marginbody_bottom,
                        "margin_body_left" => $marginbody_left,
                        "certificate_text" => $output
                );
                $this->getAdapter()->addFormFieldsFromObject($form_fields);
                return $form_fields;
        }
        
        public function processXHTML2FO($form_data, $for_export = FALSE)
        {
                $content = "<html><body>".$form_data["certificate_text"]."</body></html>";
                $content = preg_replace("/<p>(&nbsp;){1,}<\\/p>/", "<p></p>", $content);
                $content = preg_replace("/<p>(\\s)*?<\\/p>/", "<p></p>", $content);
//              $content = str_replace("<p>&nbsp;</p>", "<p><br /></p>", $content);
//              $content = str_replace("<p> </p>", "<p><br /></p>", $content);
                $content = str_replace("<p></p>", "<p class=\"emptyrow\"></p>", $content);
                $content = str_replace("&nbsp;", "&#160;", $content);
                $content = preg_replace("//", "", $content);

                include_once "./Services/Certificate/classes/class.ilXmlChecker.php";
                $check = new ilXMLChecker();
                $check->setXMLContent($content);
                $check->startParsing();
                if ($check->hasError())
                {
                        throw new Exception($this->lng->txt("certificate_not_well_formed"));
                }

                $xsl = file_get_contents("./Services/Certificate/xml/xhtml2fo.xsl");
                
                // additional font support
                $xsl = str_replace(
                                'font-family="Helvetica, unifont"',
                                'font-family="'.$GLOBALS['ilSetting']->get('rpc_pdf_font','Helvetica, unifont').'"',
                                $xsl
                );
                
                $args = array( '/_xml' => $content, '/_xsl' => $xsl );
                $xh = xslt_create();
                if (strcmp($form_data["pageformat"], "custom") == 0)
                {
                        $pageheight = $form_data["pageheight"];
                        $pagewidth = $form_data["pagewidth"];
                }
                else
                {
                        $pageformats = $this->getPageFormats();
                        $pageheight = $pageformats[$form_data["pageformat"]]["height"];
                        $pagewidth = $pageformats[$form_data["pageformat"]]["width"];
                }
                include_once "./Services/Certificate/classes/class.ilObjCertificateSettingsAccess.php";
                $backgroundimage = $this->hasBackgroundImage() ? $this->getBackgroundImagePath() : ((ilObjCertificateSettingsAccess::hasBackgroundImage()) ? ilObjCertificateSettingsAccess::getBackgroundImagePath() : "");
                $params = array(
                        "pageheight" => $pageheight, 
                        "pagewidth" => $pagewidth,
                        "backgroundimage" => $backgroundimage,
                        "marginbody" => $form_data["margin_body_top"] . " " . $form_data["margin_body_right"] . " " . $form_data["margin_body_bottom"] . " " . $form_data["margin_body_left"]
                );
                $output = xslt_process($xh, "arg:/_xml", "arg:/_xsl", NULL, $args, $params);
                xslt_error($xh);
                xslt_free($xh);
                return $output;
        }

        private function exchangeCertificateVariables($certificate_text, $insert_tags = array())
        {
                if (count($insert_tags) == 0)
                {
                        $insert_tags = $this->getAdapter()->getCertificateVariablesForPreview();
                        
                        foreach (self::getCustomCertificateFields() as $k => $f)
                        {
                                $insert_tags[$f["ph"]] = $f["name"];
                        }
                }
                foreach ($insert_tags as $var => $value)
                {
                        $certificate_text = str_replace($var, $value, $certificate_text);
                }
                return $certificate_text;
        }
        
        public function outCertificate($params, $deliver = TRUE)
        {
                global $ilLog;
                ilDatePresentation::setUseRelativeDates(false);
                $insert_tags = $this->getAdapter()->getCertificateVariablesForPresentation($params);
                
                include_once("./Services/User/classes/class.ilUserDefinedData.php");
                $cust_data = new ilUserDefinedData($this->getAdapter()->getUserIdForParams($params));
                $cust_data = $cust_data->getAll();
                foreach (self::getCustomCertificateFields() as $k => $f)
                {
                        $insert_tags[$f["ph"]] = $cust_data["f_".$k];
                }

                $xslfo = file_get_contents($this->getXSLPath());

                include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
                try
                {
                        $pdf_base64 = ilRpcClientFactory::factory('RPCTransformationHandler')->ilFO2PDF(
                                $this->exchangeCertificateVariables($xslfo, $insert_tags));
                        if ($deliver)
                        {
                                include_once "./Services/Utilities/classes/class.ilUtil.php";
                                ilUtil::deliverData($pdf_base64->scalar, $this->getAdapter()->getCertificateFilename($params), "application/pdf");
                        }
                        else
                        {
                                return $pdf_base64->scalar;
                        }
                }
                catch(XML_RPC2_FaultException $e)
                {
                        $ilLog->write(__METHOD__.': '.$e->getMessage());
                        return false;
                }
                catch(Exception $e)
                {
                        $ilLog->write(__METHOD__.': '.$e->getMessage());
                        return false;
                }

                ilDatePresentation::setUseRelativeDates(true);

                /*
                include_once "./Services/Transformation/classes/class.ilFO2PDF.php";
                $fo2pdf = new ilFO2PDF();
                $fo2pdf->setFOString($this->exchangeCertificateVariables($xslfo, $insert_tags));
                $result = $fo2pdf->send();
                if ($deliver)
                {
                        include_once "./Services/Utilities/classes/class.ilUtil.php";
                        ilUtil::deliverData($result, $this->getAdapter()->getCertificateFilename($params), "application/pdf");
                }
                else
                {
                        return $result;
                }
                */
        }

        public function createPreview()
        {
                global $ilLog;

                ilDatePresentation::setUseRelativeDates(false);

                $xslfo = file_get_contents($this->getXSLPath());

                include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
                try
                {
                        $pdf_base64 = ilRpcClientFactory::factory('RPCTransformationHandler')->ilFO2PDF(
                                $this->exchangeCertificateVariables($xslfo));
                        ilUtil::deliverData($pdf_base64->scalar, $this->getAdapter()->getCertificateFilename(), "application/pdf");

                }
                catch(XML_RPC2_FaultException $e)
                {
                        $ilLog->write(__METHOD__.': '.$e->getMessage());
                        return false;
                }
                catch(Exception $e)
                {
                        $ilLog->write(__METHOD__.': '.$e->getMessage());
                        return false;
                }

                ilDatePresentation::setUseRelativeDates(true);
                
                /*
                include_once "./Services/Transformation/classes/class.ilFO2PDF.php";
                $fo2pdf = new ilFO2PDF();
                $fo2pdf->setFOString($this->exchangeCertificateVariables($xslfo));
                $result = $fo2pdf->send();
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                ilUtil::deliverData($result, $this->getAdapter()->getCertificateFilename(), "application/pdf");
                */
        }
        
        public function saveCertificate($xslfo, $filename = "")
        {
                if (!file_exists($this->getAdapter()->getCertificatePath()))
                {
                        ilUtil::makeDirParents($this->getAdapter()->getCertificatePath());
                }
                if (strlen($filename) == 0)
                {
                        $filename = $this->getXSLPath();
                }
                $fh = fopen($filename, "w");
                fwrite($fh, $xslfo);
                fclose($fh);
        }
        
        public function uploadBackgroundImage($image_tempfilename)
        {
                if (!empty($image_tempfilename))
                {
                        $convert_filename = $this->getBackgroundImageName();
                        $imagepath = $this->getAdapter()->getCertificatePath();
                        if (!file_exists($imagepath))
                        {
                                ilUtil::makeDirParents($imagepath);
                        }
                        // upload the file
                        if (!ilUtil::moveUploadedFile(
                                        $image_tempfilename,
                                        basename($this->getBackgroundImageTempfilePath()),
                                        $this->getBackgroundImageTempfilePath()
                        )) {
                                return FALSE;
                        }
                        // convert the uploaded file to JPEG
                        ilUtil::convertImage($this->getBackgroundImageTempfilePath(), $this->getBackgroundImagePath(), "JPEG");
                        ilUtil::convertImage($this->getBackgroundImageTempfilePath(), $this->getBackgroundImageThumbPath(), "JPEG", 100);
                        if (!file_exists($this->getBackgroundImagePath()))
                        {
                                // something went wrong converting the file. use the original file and hope, that PDF can work with it
                                if (!ilUtil::moveUploadedFile($this->getBackgroundImageTempfilePath(), $convert_filename, $this->getBackgroundImagePath()))
                                {
                                        return FALSE;
                                }
                        }
                        unlink($this->getBackgroundImageTempfilePath());
                        if (file_exists($this->getBackgroundImagePath()) && (filesize($this->getBackgroundImagePath()) > 0))
                        {
                                return TRUE;
                        }
                }
                return FALSE;
        }
        
        public function hasBackgroundImage()
        {
                if (file_exists($this->getBackgroundImagePath()) && (filesize($this->getBackgroundImagePath()) > 0))
                {
                        return TRUE;
                }
                else
                {
                        return FALSE;
                }
        }
        
        public function isComplete()
        {
                if(self::isActive())
                {
                        $obj_id = $this->getAdapter()->getCertificateID();
                        if($obj_id && !self::isObjectActive($obj_id))
                        {
                                return FALSE;
                        }
                        if (file_exists($this->getAdapter()->getCertificatePath()))
                        {
                                if (file_exists($this->getXSLPath()) && (filesize($this->getXSLPath()) > 0))
                                {
                                        return TRUE;
                                }
                        }
                }
                return FALSE;
        }
        
        function _isComplete($adapter)
        {
                if (is_object($adapter) && method_exists($adapter, "getCertificatePath"))
                {
                        if(self::isActive())
                        {
                                $obj_id = $adapter->getCertificateID();
                                if($obj_id && !self::isObjectActive($obj_id))
                                {
                                        return FALSE;
                                }
                        
                                $certificatepath = $adapter->getCertificatePath();
                                if (file_exists($certificatepath))
                                {
                                        $xslpath = $adapter->getCertificatePath() . ilCertificate::_getXSLName();
                                        if (file_exists($xslpath) && (filesize($xslpath) > 0))
                                        {
                                                return TRUE;
                                        }
                                }
                        }
                }
                return FALSE;
        }
        
        public function getPageFormats()
        {
                return array(
                        "a4" => array(
                                "name" => $this->lng->txt("certificate_a4"), // (297 mm x 210 mm)
                                "value" => "a4",
                                "width" => "210mm",
                                "height" => "297mm"
                        ),
                        "a4landscape" => array(
                                "name" => $this->lng->txt("certificate_a4_landscape"), // (210 mm x 297 mm)",
                                "value" => "a4landscape",
                                "width" => "297mm",
                                "height" => "210mm"
                        ),
                        "a5" => array(
                                "name" => $this->lng->txt("certificate_a5"), // (210 mm x 148.5 mm)
                                "value" => "a5",
                                "width" => "148mm",
                                "height" => "210mm"
                        ),
                        "a5landscape" => array(
                                "name" => $this->lng->txt("certificate_a5_landscape"), // (148.5 mm x 210 mm)
                                "value" => "a5landscape",
                                "width" => "210mm",
                                "height" => "148mm"
                        ),
                        "letter" => array(
                                "name" => $this->lng->txt("certificate_letter"), // (11 inch x 8.5 inch)
                                "value" => "letter",
                                "width" => "8.5in",
                                "height" => "11in"
                        ),
                        "letterlandscape" => array(
                                "name" => $this->lng->txt("certificate_letter_landscape"), // (8.5 inch x 11 inch)
                                "value" => "letterlandscape",
                                "width" => "11in",
                                "height" => "8.5in"
                        ),
                        "custom" => array(
                                "name" => $this->lng->txt("certificate_custom"),
                                "value" => "custom",
                                "width" => "",
                                "height" => ""
                        )
                );
        }

        public function deliverExportFileXML()
        {
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                $exportpath = $this->createArchiveDirectory();
                ilUtil::makeDir($exportpath);
                $xsl = file_get_contents($this->getXSLPath());
                $xslexport = str_replace($this->getAdapter()->getCertificatePath(), "", $xsl);
                // save export xsl file
                $this->saveCertificate($xslexport, $exportpath . $this->getXSLName());
                // save background image
                if ($this->hasBackgroundImage())
                {
                        copy($this->getBackgroundImagePath(), $exportpath . $this->getBackgroundImageName());
                }
                else
                {
                        include_once "./Services/Certificate/classes/class.ilObjCertificateSettingsAccess.php";
                        if (ilObjCertificateSettingsAccess::hasBackgroundImage())
                        {
                                copy(ilObjCertificateSettingsAccess::getBackgroundImagePath(), $exportpath . ilObjCertificateSettingsAccess::getBackgroundImageName());
                        }
                }
                $zipfile = time() . "__" . IL_INST_ID . "__" . $this->getAdapter()->getAdapterType() . "__" . $this->getAdapter()->getCertificateId() . "__certificate.zip";
                ilUtil::zip($exportpath, $this->getAdapter()->getCertificatePath() . $zipfile);
                ilUtil::delDir($exportpath);
                ilUtil::deliverFile($this->getAdapter()->getCertificatePath() . $zipfile, $zipfile, "application/zip");
        }
        
        public function importCertificate($zipfile, $filename)
        {
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                $importpath = $this->createArchiveDirectory();
                if (!ilUtil::moveUploadedFile($zipfile, $filename, $importpath . $filename))
                {
                        ilUtil::delDir($importpath);
                        return FALSE;
                }
                ilUtil::unzip($importpath . $filename, TRUE);
                $subdir = str_replace(".zip", "", strtolower($filename)) . "/";
                $copydir = "";
                if (is_dir($importpath . $subdir))
                {
                        $dirinfo = ilUtil::getDir($importpath . $subdir);
                        $copydir = $importpath . $subdir;
                }
                else
                {
                        $dirinfo = ilUtil::getDir($importpath);
                        $copydir = $importpath;
                }
                $xmlfiles = 0;
                $otherfiles = 0;
                foreach ($dirinfo as $file)
                {
                        if (strcmp($file["type"], "file") == 0)
                        {
                                if (strpos($file["entry"], ".xml") !== FALSE) 
                                {
                                        $xmlfiles++;
                                }
                                else if (strpos($file["entry"], ".zip") !== FALSE)
                                {
                                }
                                else
                                {
                                        $otherfiles++;
                                }
                        }
                }
                // if one XML file is in the archive, we try to import it
                if ($xmlfiles == 1)
                {
                        foreach ($dirinfo as $file)
                        {
                                if (strcmp($file["type"], "file") == 0)
                                {
                                        if (strpos($file["entry"], ".xml") !== FALSE) 
                                        {
                                                $xsl = file_get_contents($copydir . $file["entry"]);
                                                // as long as we cannot make RPC calls in a given directory, we have
                                                // to add the complete path to every url
                                                $xsl = preg_replace("/url\([']{0,1}(.*?)[']{0,1}\)/", "url(" . $this->getAdapter()->getCertificatePath() . "\${1})", $xsl);
                                                $this->saveCertificate($xsl);
                                        }
                                        else if (strpos($file["entry"], ".zip") !== FALSE)
                                        {
                                        }
                                        else
                                        {
                                                @copy($copydir . $file["entry"], $this->getAdapter()->getCertificatePath() . $file["entry"]);
                                                if (strcmp($this->getBackgroundImagePath(), $this->getAdapter()->getCertificatePath() . $file["entry"]) == 0)
                                                {
                                                        // upload of the background image, create a preview
                                                        ilUtil::convertImage($this->getBackgroundImagePath(), $this->getBackgroundImageThumbPath(), "JPEG", 100);
                                                }
                                        }
                                }
                        }
                }
                else
                {
                        ilUtil::delDir($importpath);
                        return FALSE;
                }
                ilUtil::delDir($importpath);
                return TRUE;
        }
        
        public function getAdapter()
        {
                return $this->adapter;
        }
        
        public function setAdapter($adapter)
        {
                $this->adapter =& $adapter;
        }
        
        /***************************************
        /* BULK CERTIFICATE PROCESSING METHODS *
        /***************************************

        public function createArchiveDirectory()
        {
                $dir = $this->getAdapter()->getCertificatePath() . time() . "__" . IL_INST_ID . "__" . $this->getAdapter()->getAdapterType() . "__" . $this->getAdapter()->getCertificateId() . "__certificate/";
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                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";
                ilUtil::zip($dir, $this->getAdapter()->getCertificatePath() . $zipfile);
                ilUtil::delDir($dir);
                if ($deliver)
                {
                        ilUtil::deliverFile($this->getAdapter()->getCertificatePath() . $zipfile, $zipfile, "application/zip");
                }
                return $this->getAdapter()->getCertificatePath() . $zipfile;
        }
        
        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 $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()
        {
                global $ilDB;
                
                $obj_id = $this->adapter->getCertificateID();
                $set = $ilDB->query("SELECT obj_id FROM il_certificate".
                        " WHERE obj_id = ".$ilDB->quote($obj_id, "integer"));
            return $ilDB->numRows($set);
        }       
        
        public function writeActive($a_value)
        {
                global $ilDB;
                
                $obj_id = $this->adapter->getCertificateID();
                
                if((bool)$a_value)
                {
                        $ilDB->replace("il_certificate",
                                array("obj_id"=>array("integer", $obj_id)),
                                array());               
                }
                else
                {
                        $ilDB->manipulate("DELETE FROM il_certificate".
                                " WHERE obj_id = ".$ilDB->quote($obj_id, "integer"));
                }
        }       
        
        public static function _goto($ref_id)
        {
                global $ilCtrl;
                include_once "./Services/Object/classes/class.ilObject.php";
                $type = ilObject::_lookupType($ref_id, true);
                switch ($type)
                {
                        case 'sahs':
                                $cmd_link = "ilias.php?baseClass=ilSAHSPresentationGUI&ref_id=".$ref_id.
                                        "&cmd=downloadCertificate";
                                ilUtil::redirect($cmd_link);
                                break;
                        case 'tst':
                        default:
                                $ilCtrl->redirectByClass("ilrepositorygui", "frameset");
                                break;
                }
        }
        
        static function getCustomCertificateFields()
        {
                include_once("./Services/User/classes/class.ilUserDefinedFields.php");
                $user_field_definitions = ilUserDefinedFields::_getInstance();
                $fds = $user_field_definitions->getDefinitions();
                $fields = array();
                foreach ($fds as $f)
                {
                        if ($f["certificate"])
                        {
                                $fields[$f["field_id"]] = array("name" => $f["field_name"],
                                        "ph" => "[#".str_replace(" ", "_", strtoupper($f["field_name"]))."]");
                        }
                }
                
                return $fields;
        }

        public function getExchangeContent()
        {
                if(!file_exists($this->getXSLPath()))
                {
                        return '';
                }

                $output           = '';
                $xsl_file_content = file_get_contents($this->getXSLPath());
                $xsl              = file_get_contents("./Services/Certificate/xml/fo2xhtml.xsl");

                if((strlen($xsl_file_content)) && (strlen($xsl)))
                {
                        $args   = array('/_xml' => $xsl_file_content, '/_xsl' => $xsl);
                        $xh     = xslt_create();
                        $output = xslt_process($xh, "arg:/_xml", "arg:/_xsl", NULL, $args, NULL);
                        xslt_error($xh);
                        xslt_free($xh);
                }

                $output = preg_replace("/<\?xml[^>]+?>/", "", $output);
                // dirty hack: the php xslt processing seems not to recognize the following
                // replacements, so we do it in the code as well
                $output = str_replace("&#xA0;", "<br />", $output);
                $output = str_replace("&#160;", "<br />", $output);

                return $output;
        }

        public function outCertificateWithGivenContentAndVariables($content, $insert_tags)
        {
                global $ilLog;

                ilDatePresentation::setUseRelativeDates(false);

                $form_fields = $this->getFormFieldsFromFO();
                $form_fields['certificate_text'] = $content;
                $xslfo = $this->processXHTML2FO($form_fields);

                $content = $this->exchangeCertificateVariables($xslfo, $insert_tags);
                $content = str_replace('[BR]', "<fo:block/>", $content);

                include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
                try
                {
                        $pdf_base64 = ilRpcClientFactory::factory('RPCTransformationHandler')->ilFO2PDF($content);
                        include_once "./Services/Utilities/classes/class.ilUtil.php";
                        ilUtil::deliverData($pdf_base64->scalar, $this->getAdapter()->getCertificateFilename(array()), "application/pdf");
                }
                catch(XML_RPC2_FaultException $e)
                {
                        $ilLog->write(__METHOD__.': '.$e->getMessage());
                        return false;
                }
                catch(Exception $e)
                {
                        $ilLog->write(__METHOD__.': '.$e->getMessage());
                        return false;
                }

                ilDatePresentation::setUseRelativeDates(true);
        }
}

?>