]*>\[!--\sBEGIN\s' . $string . '\s--\](.*)\[!--.+END\s' . $string . '\s--\]<\/text:p>@smU';
$reg = '@\[!--\sBEGIN\s' . $string . '\s--\](.*)\[!--.+END\s' . $string . '\s--\]@smU';
$this->contentXml = preg_replace($reg, $segment->getXmlParsed(), $this->contentXml);
return $this;
}
/**
* Display all the current template variables
*
* @return string
*/
public function printVars()
{
return print_r('' . print_r($this->vars, true) . '
', true);
}
/**
* Display the XML content of the file from odt document
* as it is at the moment
*
* @return string
*/
public function __toString()
{
return $this->contentXml;
}
/**
* Display loop segments declared with setSegment()
*
* @return string
*/
public function printDeclaredSegments()
{
return '' . print_r(implode(' ', array_keys($this->segments)), true) . '';
}
/**
* Declare a segment in order to use it in a loop.
* Extract the segment and store it into $this->segments[]. Return it for next call.
*
* @param string $segment Segment
* @throws OdfExceptionSegmentNotFound
* @return Segment
*/
public function setSegment($segment)
{
if (array_key_exists($segment, $this->segments)) {
return $this->segments[$segment];
}
// $reg = "#\[!--\sBEGIN\s$segment\s--\]<\/text:p>(.*)\[!--\sEND\s$segment\s--\]#sm";
$reg = "#\[!--\sBEGIN\s$segment\s--\](.*)\[!--\sEND\s$segment\s--\]#sm";
$m = array();
if (preg_match($reg, html_entity_decode($this->contentXml), $m) == 0) {
throw new OdfExceptionSegmentNotFound("'".$segment."' segment not found in the document. The tag [!-- BEGIN xxx --] or [!-- END xxx --] is not present into content file.");
}
$this->segments[$segment] = new Segment($segment, $m[1], $this);
return $this->segments[$segment];
}
/**
* Save the odt file on the disk
*
* @param string $file name of the desired file
* @throws OdfException
* @return void
*/
public function saveToDisk($file = null)
{
if ($file !== null && is_string($file)) {
if (file_exists($file) && !(is_file($file) && is_writable($file))) {
throw new OdfException('Permission denied : can\'t create ' . $file);
}
$this->_save();
copy($this->tmpfile, $file);
} else {
$this->_save();
}
}
/**
* Write output file onto disk
*
* @throws OdfException
* @return void
*/
private function _save()
{
$res=$this->file->open($this->tmpfile); // tmpfile is odt template
$this->_parse('content');
$this->_parse('styles');
$this->_parse('meta');
$this->setMetaData();
//print $this->metaXml;exit;
if (! $this->file->addFromString('content.xml', $this->contentXml)) {
throw new OdfException('Error during file export addFromString content');
}
if (! $this->file->addFromString('meta.xml', $this->metaXml)) {
throw new OdfException('Error during file export addFromString meta');
}
if (! $this->file->addFromString('styles.xml', $this->stylesXml)) {
throw new OdfException('Error during file export addFromString styles');
}
foreach ($this->images as $imageKey => $imageValue) {
// Add the image inside the ODT document
$this->file->addFile($imageKey, 'Pictures/' . $imageValue);
// Add the image to the Manifest (which maintains a list of images, necessary to avoid "Corrupt ODT file. Repair?" when opening the file with LibreOffice)
$this->addImageToManifest($imageValue);
}
if (! $this->file->addFromString('./META-INF/manifest.xml', $this->manifestXml)) {
throw new OdfException('Error during file export: manifest.xml');
}
$this->file->close();
}
/**
* Update Meta information
* 2013-03-16T14:06:25
*
* @return void
*/
public function setMetaData()
{
if (empty($this->creator)) $this->creator='';
$this->metaXml = preg_replace('/.*<\/dc:date>/', ''.gmdate("Y-m-d\TH:i:s").'', $this->metaXml);
$this->metaXml = preg_replace('/.*<\/dc:creator>/', ''.htmlspecialchars($this->creator).'', $this->metaXml);
$this->metaXml = preg_replace('/.*<\/dc:title>/', ''.htmlspecialchars($this->title).'', $this->metaXml);
$this->metaXml = preg_replace('/.*<\/dc:subject>/', ''.htmlspecialchars($this->subject).'', $this->metaXml);
if (count($this->userdefined)) {
foreach ($this->userdefined as $key => $val) {
$this->metaXml = preg_replace('', '', $this->metaXml);
$this->metaXml = preg_replace('/.*<\/meta:user-defined>/', '', $this->metaXml);
$this->metaXml = str_replace('', ''.htmlspecialchars($val).'', $this->metaXml);
}
}
}
/**
* Update Manifest file according to added image files
*
* @param string $file Image file to add into manifest content
* @return void
*/
public function addImageToManifest($file)
{
// Get the file extension
$ext = substr(strrchr($file, '.'), 1);
// Create the correct image XML entry to add to the manifest (this is necessary because ODT format requires that we keep a list of the images in the manifest.xml)
$add = ' '."\n";
// Append the image to the manifest
$this->manifestXml = str_replace('', $add.'', $this->manifestXml); // we replace the manifest closing tag by the image XML entry + manifest closing tag (this results in appending the data, we do not overwrite anything)
}
/**
* Export the file as attached file by HTTP
*
* @param string $name (optional)
* @throws OdfException
* @return void
*/
public function exportAsAttachedFile($name = "")
{
$this->_save();
if (headers_sent($filename, $linenum)) {
throw new OdfException("headers already sent ($filename at $linenum)");
}
if ( $name == "" ) {
$name = md5(uniqid()) . ".odt";
}
header('Content-type: application/vnd.oasis.opendocument.text');
header('Content-Disposition: attachment; filename="'.$name.'"');
header('Content-Length: '.filesize($this->tmpfile));
readfile($this->tmpfile);
}
/**
* Convert the ODT file to PDF and export the file as attached file by HTTP
* Note: you need to have JODConverter and OpenOffice or LibreOffice installed and executable on the same system as where this php script will be executed. You also need to chmod +x odt2pdf.sh
*
* @param string $name Name of ODT file to generate before generating PDF
* @throws OdfException
* @return void
*/
public function exportAsAttachedPDF($name = "")
{
global $conf;
if ( $name == "" ) $name = "temp".md5(uniqid());
dol_syslog(get_class($this).'::exportAsAttachedPDF $name='.$name, LOG_DEBUG);
$this->saveToDisk($name);
$execmethod=(empty($conf->global->MAIN_EXEC_USE_POPEN)?1:2); // 1 or 2
// Method 1 sometimes hang the server.
// Export to PDF using LibreOffice
if (getDolGlobalString('MAIN_ODT_AS_PDF') == 'libreoffice') {
dol_mkdir($conf->user->dir_temp); // We must be sure the directory exists and is writable
// We delete and recreate a subdir because the soffice may have change pemrissions on it
dol_delete_dir_recursive($conf->user->dir_temp.'/odtaspdf');
dol_mkdir($conf->user->dir_temp.'/odtaspdf');
// Install prerequisites: apt install soffice libreoffice-common libreoffice-writer
// using windows libreoffice that must be in path
// using linux/mac libreoffice that must be in path
// Note PHP Config "fastcgi.impersonate=0" must set to 0 - Default is 1
$command ='soffice --headless -env:UserInstallation=file:\''.$conf->user->dir_temp.'/odtaspdf\' --convert-to pdf --outdir '. escapeshellarg(dirname($name)). " ".escapeshellarg($name);
} elseif (preg_match('/unoconv/', getDolGlobalString('MAIN_ODT_AS_PDF'))) {
// If issue with unoconv, see https://github.com/dagwieers/unoconv/issues/87
// MAIN_ODT_AS_PDF should be "sudo -u unoconv /usr/bin/unoconv" and userunoconv must have sudo to be root by adding file /etc/sudoers.d/unoconv with content www-data ALL=(unoconv) NOPASSWD: /usr/bin/unoconv .
// Try this with www-data user: /usr/bin/unoconv -vvvv -f pdf /tmp/document-example.odt
// It must return:
//Verbosity set to level 4
//Using office base path: /usr/lib/libreoffice
//Using office binary path: /usr/lib/libreoffice/program
//DEBUG: Connection type: socket,host=127.0.0.1,port=2002;urp;StarOffice.ComponentContext
//DEBUG: Existing listener not found.
//DEBUG: Launching our own listener using /usr/lib/libreoffice/program/soffice.bin.
//LibreOffice listener successfully started. (pid=9287)
//Input file: /tmp/document-example.odt
//unoconv: file `/tmp/document-example.odt' does not exist.
//unoconv: RuntimeException during import phase:
//Office probably died. Unsupported URL : "type detection failed"
//DEBUG: Terminating LibreOffice instance.
//DEBUG: Waiting for LibreOffice instance to exit
// If it fails:
// - set shell of user to bash instead of nologin.
// - set permission to read/write to user on home directory /var/www so user can create the libreoffice , dconf and .cache dir and files then set permission back
$command = getDolGlobalString('MAIN_ODT_AS_PDF').' '.escapeshellcmd($name);
//$command = '/usr/bin/unoconv -vvv '.escapeshellcmd($name);
} else {
// deprecated old method using odt2pdf.sh (native, jodconverter, ...)
$tmpname=preg_replace('/\.odt/i', '', $name);
if (getDolGlobalString('MAIN_DOL_SCRIPTS_ROOT')) {
$command = getDolGlobalString('MAIN_DOL_SCRIPTS_ROOT').'/scripts/odt2pdf/odt2pdf.sh '.escapeshellcmd($tmpname).' '.(is_numeric(getDolGlobalString('MAIN_ODT_AS_PDF'))?'jodconverter':getDolGlobalString('MAIN_ODT_AS_PDF'));
} else {
dol_syslog(get_class($this).'::exportAsAttachedPDF is used but the constant MAIN_DOL_SCRIPTS_ROOT with path to script directory was not defined.', LOG_WARNING);
$command = '../../scripts/odt2pdf/odt2pdf.sh '.escapeshellcmd($tmpname).' '.(is_numeric(getDolGlobalString('MAIN_ODT_AS_PDF'))?'jodconverter':getDolGlobalString('MAIN_ODT_AS_PDF'));
}
}
//$dirname=dirname($name);
//$command = DOL_DOCUMENT_ROOT.'/includes/odtphp/odt2pdf.sh '.$name.' '.$dirname;
dol_syslog(get_class($this).'::exportAsAttachedPDF $execmethod='.$execmethod.' Run command='.$command, LOG_DEBUG);
// TODO Use:
// $outputfile = DOL_DATA_ROOT.'/odt2pdf.log';
// $result = $utils->executeCLI($command, $outputfile); and replace test on $execmethod.
// $retval will be $result['result']
// $errorstring will be $result['output']
$retval=0; $output_arr=array();
if ($execmethod == 1) {
exec($command, $output_arr, $retval);
}
if ($execmethod == 2) {
$outputfile = DOL_DATA_ROOT.'/odt2pdf.log';
$ok=0;
$handle = fopen($outputfile, 'w');
if ($handle) {
dol_syslog(get_class($this)."Run command ".$command, LOG_DEBUG);
fwrite($handle, $command."\n");
$handlein = popen($command, 'r');
while (!feof($handlein)) {
$read = fgets($handlein);
fwrite($handle, $read);
$output_arr[]=$read;
}
pclose($handlein);
fclose($handle);
}
dolChmod($outputfile);
}
if ($retval == 0) {
dol_syslog(get_class($this).'::exportAsAttachedPDF $ret_val='.$retval, LOG_DEBUG);
$filename=''; $linenum=0;
if (php_sapi_name() != 'cli') { // If we are in a web context (not into CLI context)
if (headers_sent($filename, $linenum)) {
throw new OdfException("headers already sent ($filename at $linenum)");
}
if (!empty($conf->global->MAIN_DISABLE_PDF_AUTOUPDATE)) {
$name=preg_replace('/\.od(x|t)/i', '', $name);
header('Content-type: application/pdf');
header('Content-Disposition: attachment; filename="'.$name.'.pdf"');
readfile($name.".pdf");
}
}
if (!empty($conf->global->MAIN_ODT_AS_PDF_DEL_SOURCE)) {
unlink($name);
}
} else {
dol_syslog(get_class($this).'::exportAsAttachedPDF $ret_val='.$retval, LOG_DEBUG);
dol_syslog(get_class($this).'::exportAsAttachedPDF $output_arr='.var_export($output_arr, true), LOG_DEBUG);
if ($retval == 126) {
throw new OdfException('Permission execute convert script : ' . $command);
} else {
$errorstring='';
foreach ($output_arr as $line) {
$errorstring.= $line."
";
}
throw new OdfException('ODT to PDF convert fail (option MAIN_ODT_AS_PDF is '.$conf->global->MAIN_ODT_AS_PDF.', command was '.$command.', retval='.$retval.') : ' . $errorstring);
}
}
}
/**
* Returns a variable of configuration
*
* @param string $configKey Config key
* @return string The requested variable of configuration
*/
public function getConfig($configKey)
{
if (array_key_exists($configKey, $this->config)) {
return $this->config[$configKey];
}
return false;
}
/**
* Returns the temporary working file
*
* @return string le chemin vers le fichier temporaire de travail
*/
public function getTmpfile()
{
return $this->tmpfile;
}
/**
* Delete the temporary file when the object is destroyed
*/
public function __destruct()
{
if (file_exists($this->tmpfile)) {
unlink($this->tmpfile);
}
if (file_exists($this->tmpdir)) {
$this->_rrmdir($this->tmpdir);
rmdir($this->tmpdir);
}
}
/**
* Empty the temporary working directory recursively
*
* @param string $dir The temporary working directory
* @return void
*/
private function _rrmdir($dir)
{
if ($handle = opendir($dir)) {
while (($file = readdir($handle)) !== false) {
if ($file != '.' && $file != '..') {
if (is_dir($dir . '/' . $file)) {
$this->_rrmdir($dir . '/' . $file);
rmdir($dir . '/' . $file);
} else {
unlink($dir . '/' . $file);
}
}
}
closedir($handle);
}
}
/**
* return the value present on odt in [valuename][/valuename]
*
* @param string $valuename Balise in the template
* @return string The value inside the balise
*/
public function getvalue($valuename)
{
$searchreg="/\\[".$valuename."\\](.*)\\[\\/".$valuename."\\]/";
$matches = array();
preg_match($searchreg, $this->contentXml, $matches);
$this->contentXml = preg_replace($searchreg, "", $this->contentXml);
if ($matches) {
return $matches[1];
}
return "";
}
}