2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
7 * This program is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU Affero General Public License version 3 as published by the
9 * Free Software Foundation with the addition of the following permission added
10 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
12 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
19 * You should have received a copy of the GNU Affero General Public License along with
20 * this program; if not, see http://www.gnu.org/licenses or write to the Free
21 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
25 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
27 * The interactive user interfaces in modified source and object code versions
28 * of this program must display Appropriate Legal Notices, as required under
29 * Section 5 of the GNU Affero General Public License version 3.
31 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32 * these Appropriate Legal Notices must retain the display of the "Powered by
33 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
34 * technical reasons, the Appropriate Legal Notices must display the words
35 * "Powered by SugarCRM".
36 ********************************************************************************/
40 if(file_exists('custom/include/Sugarpdf/sugarpdf_config.php')){
41 require_once('custom/include/Sugarpdf/sugarpdf_config.php');
43 require_once('include/Sugarpdf/sugarpdf_config.php');
46 require_once('include/tcpdf/tcpdf.php');
47 require_once('include/Sugarpdf/SugarpdfHelper.php');
49 class Sugarpdf extends TCPDF
52 * Stretch options constants
54 const STRETCH_NONE = 0;
55 const STRETCH_SCALE = 1;
56 const STRETCH_SCALE_FORCED = 2;
57 const STRETCH_SPACING = 3;
58 const STRETCH_SPACING_FORCED = 4;
61 * This array is meant to hold an objects/data that we would like to pass between
62 * the controller and the view. The bean will automatically be set for us, but this
63 * is meant to hold anything else.
65 var $sugarpdf_object_map = array();
67 * The name of the current module.
71 * The name of the current action.
78 * Any errors that occured this can either be set by the view or the controller or the model
80 var $errors = array();
82 * Use to set the filename of the output pdf file.
84 var $fileName = PDF_FILENAME;
86 * Use for the ACL access.
88 var $aclAction = PDF_ACL_ACCESS;
90 * Constructor which will peform the setup.
94 function __construct($bean = null, $sugarpdf_object_map = array(),$orientation=PDF_PAGE_ORIENTATION, $unit=PDF_UNIT, $format=PDF_PAGE_FORMAT, $unicode=true, $encoding='UTF-8', $diskcache=false){
96 // $encoding = $locale->getExportCharset();
100 parent::__construct($orientation,$unit,$format,$unicode,$encoding,$diskcache);
101 $this->module = $GLOBALS['module'];
103 $this->sugarpdf_object_map = $sugarpdf_object_map;
104 if(!empty($_REQUEST["sugarpdf"])){
105 $this->action = $_REQUEST["sugarpdf"];
110 * This method will be called from the controller and is not meant to be overridden.
119 * This method will display the errors on the page.
121 function displayErrors(){
122 foreach($this->errors as $error) {
123 echo '<span class="error">' . $error . '</span><br>';
128 * [OVERRIDE] - This method is meant to overidden in a subclass. The purpose of this method is
129 * to allow a view to do some preprocessing before the display method is called. This becomes
130 * useful when you have a view defined at the application level and then within a module
131 * have a sub-view that extends from this application level view. The application level
132 * view can do the setup in preDisplay() that is common to itself and any subviews
133 * and then the subview can just override display(). If it so desires, can also override
136 function preDisplay(){
137 // set document information
138 $this->SetCreator(PDF_CREATOR);
139 $this->SetAuthor(PDF_AUTHOR);
140 $this->SetTitle(PDF_TITLE);
141 $this->SetSubject(PDF_SUBJECT);
142 $this->SetKeywords(PDF_KEYWORDS);
144 // set other properties
146 if(PDF_COMPRESSION == "on"){
149 $this->SetCompression($compression);
151 if(PDF_PROTECTION != ""){
152 $protection=explode(",",PDF_PROTECTION);
155 $this->SetProtection($protection,blowfishDecode(blowfishGetKey('sugarpdf_pdf_user_password'), PDF_USER_PASSWORD),blowfishDecode(blowfishGetKey('sugarpdf_pdf_owner_password'), PDF_OWNER_PASSWORD));
156 $this->setCellHeightRatio(K_CELL_HEIGHT_RATIO);
157 $this->setJPEGQuality(intval(PDF_JPEG_QUALITY));
158 $this->setPDFVersion(PDF_PDF_VERSION);
160 // set default header data
161 $this->setHeaderData(PDF_HEADER_LOGO, PDF_HEADER_LOGO_WIDTH, PDF_HEADER_TITLE, PDF_HEADER_STRING);
163 // set header and footer fonts
164 $this->setHeaderFont(Array(PDF_FONT_NAME_MAIN, '', PDF_FONT_SIZE_MAIN));
165 $this->setFooterFont(Array(PDF_FONT_NAME_DATA, '', PDF_FONT_SIZE_DATA));
168 $this->SetMargins(PDF_MARGIN_LEFT, PDF_MARGIN_TOP, PDF_MARGIN_RIGHT);
169 $this->setHeaderMargin(PDF_MARGIN_HEADER);
170 $this->setFooterMargin(PDF_MARGIN_FOOTER);
172 //set auto page breaks
173 $this->SetAutoPageBreak(TRUE, PDF_MARGIN_BOTTOM);
175 //set image scale factor
176 $this->setImageScale(PDF_IMAGE_SCALE_RATIO);
178 //set some language-dependent strings
179 //$this->setLanguageArray($l);
181 // ---------------------------------------------------------
186 * [OVERRIDE] - This method is meant to overidden in a subclass.
190 $this->SetFont(PDF_FONT_NAME_MAIN,'B',16);
191 $this->MultiCell(0,0,'Tcpdf class for this module and action has not been implemented.',0,'C');
199 * This method override the regular Header() method to enable the custom image directory in addition to the OOB image directory.
200 * This method is used to render the page header.
201 * It is automatically called by AddPage().
203 * @see include/tcpdf/TCPDF#Header()
205 public function Header() {
206 $ormargins = $this->getOriginalMargins();
207 $headerfont = $this->getHeaderFont();
208 $headerdata = $this->getHeaderData();
210 if (($headerdata['logo']) AND ($headerdata['logo'] != K_BLANK_IMAGE)) {
213 $logo = K_PATH_CUSTOM_IMAGES.$headerdata['logo'];
214 $imsize = @getimagesize($logo);
215 if ($imsize === FALSE) {
216 // encode spaces on filename
217 $logo = str_replace(' ', '%20', $logo);
218 $imsize = @getimagesize($logo);
219 if ($imsize === FALSE) {
220 $logo = K_PATH_IMAGES.$headerdata['logo'];
225 $this->Image($logo, $this->GetX(), $this->getHeaderMargin(), $headerdata['logo_width']);
226 $imgy = $this->getImageRBY();
228 $imgy = $this->GetY();
230 $cell_height = round(($this->getCellHeightRatio() * $headerfont[2]) / $this->getScaleFactor(), 2);
231 // set starting margin for text data cell
232 if ($this->getRTL()) {
233 $header_x = $ormargins['right'] + ($headerdata['logo_width'] * 1.1);
235 $header_x = $ormargins['left'] + ($headerdata['logo_width'] * 1.1);
237 $this->SetTextColor(0, 0, 0);
239 $this->SetFont($headerfont[0], 'B', $headerfont[2] + 1);
240 $this->SetX($header_x);
241 $this->Cell(0, $cell_height, $headerdata['title'], 0, 1, '', 0, '', 0);
243 $this->SetFont($headerfont[0], $headerfont[1], $headerfont[2]);
244 $this->SetX($header_x);
245 $this->MultiCell(0, $cell_height, $headerdata['string'], 0, '', 0, 1, '', '', true, 0, false);
246 // print an ending header line
247 $this->SetLineStyle(array('width' => 0.85 / $this->getScaleFactor(), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)));
248 $this->SetY((2.835 / $this->getScaleFactor()) + max($imgy, $this->GetY()));
249 if ($this->getRTL()) {
250 $this->SetX($ormargins['right']);
252 $this->SetX($ormargins['left']);
254 $this->Cell(0, 0, '', 'T', 0, 'C');
258 * [OVERRIDE] SetFont method in TCPDF Library
259 * This method override the regular SetFont() method to enable the custom font directory in addition to the OOB font directory.
261 * @param string $family Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive):<ul><li>times (Times-Roman)</li><li>timesb (Times-Bold)</li><li>timesi (Times-Italic)</li><li>timesbi (Times-BoldItalic)</li><li>helvetica (Helvetica)</li><li>helveticab (Helvetica-Bold)</li><li>helveticai (Helvetica-Oblique)</li><li>helveticabi (Helvetica-BoldOblique)</li><li>courier (Courier)</li><li>courierb (Courier-Bold)</li><li>courieri (Courier-Oblique)</li><li>courierbi (Courier-BoldOblique)</li><li>symbol (Symbol)</li><li>zapfdingbats (ZapfDingbats)</li></ul> It is also possible to pass an empty string. In that case, the current family is retained.
262 * @param string $style Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line trough</li></ul> or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats basic fonts or other fonts when not defined.
263 * @param float $size Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12
264 * @param string $fontfile The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
266 * @see include/tcpdf/TCPDF#SetFont()
268 public function SetFont($family, $style='', $size=0, $fontfile='') {
270 if(empty($fontfile) && defined('K_PATH_CUSTOM_FONTS')){
271 // This will force addFont to search the custom directory for font before the OOB directory
272 $fontfile = K_PATH_CUSTOM_FONTS."phantomFile.phantom";
274 parent::SetFont($family, $style, $size, $fontfile);
279 $this->SetFont(PDF_FONT_NAME_MAIN,'',12);
280 $this->MultiCell(0,0,'---',0,'L');
281 $this->MultiCell(0,0,'Class: '.get_class($this),0,'L');
282 $this->MultiCell(0,0,'Extends: '.get_parent_class($this),0,'L');
283 $this->MultiCell(0,0,'---',0,'L');
284 $this->MultiCell(0,0,'Module: '.$this->module,0,'L');
285 $this->MultiCell(0,0,'Tcpdf Action: '.$this->action,0,'L');
286 $this->MultiCell(0,0,'Bean ID: '.$this->bean->getFieldValue('id'),0,'L');
287 $this->SetFont(PDF_FONT_NAME_MAIN,'',12);
288 $this->MultiCell(0,0,'---',0,'L');
293 * [OVERRIDE] Cell method in tcpdf library.
294 * Handle charset conversion and HTML entity decode.
295 * This method override the regular Cell() method to apply the prepare_string() function to
296 * the string to print in the PDF.
297 * The cell method is used by all the methods which print text (Write, MultiCell).
298 * @see include/tcpdf/TCPDF#Cell()
300 public function Cell($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=0, $link='', $stretch=0) {
301 parent::Cell($w, $h, prepare_string($txt), $border, $ln, $align, $fill, $link, $stretch);
305 * This Ln1() method will always print a line break of one line height.
306 * The regular Ln() method print a line break which has the height of the last printed cell.
308 public function Ln1() {
309 parent::Ln($this->FontSize * $this->cell_height_ratio + 2 * $this->cMargin, false);
314 * This method allow printing a table using the MultiCell method with a formatted options array in parameter
316 * header options override the regular options for the header's cells - $options['header']
317 * cell options override the regular options for the specific cell - Array[line number (0 to x)][cell header]['options']
318 * @param $item Array[line number (0 to x)][cell header] = Cell content OR
319 * Array[line number (0 to x)][cell header]['value'] = Cell content AND
320 * Array[line number (0 to x)][cell header]['options'] = Array[cell properties] = values
321 * @param $options Array which can contain : width (array 'column name'=>'width value + % OR nothing'), isheader (bool), header (array), fill (string: HTML color), ishtml (bool) default: false, border (0: no border (defaul), 1: frame or all of the following characters: L ,T ,R ,B), align (L: left align, C: center, R: right align, J: justification), stretch (array 'column name'=>stretch type)
324 public function writeCellTable($item, $options=NULL)
326 // Save initial font values
327 $fontFamily = $this->getFontFamily();
328 $fontSize = $this->getFontSizePt();
329 $fontStyle = $this->getFontStyle();
330 $this->SetTextColor(0, 0, 0);
332 $options = $this->initOptionsForWriteCellTable($options, $item);
335 if(!isset($options['isheader']) || $options['isheader'] == true){
336 $headerOptions = $options;
337 if(!empty($options['header']) && is_array($options['header'])){
338 $headerOptions = $this->initOptionsForWriteCellTable($options['header'], $item);
340 foreach($item[0] as $k => $v){
343 $h = $this->getLineHeightFromArray($header, $options["width"]);
344 foreach ($header as $v)
345 $this->MultiCell($options["width"][$v],$h,$v,$headerOptions['border'],$headerOptions['align'],$headerOptions['fillstate'],0,'','',true, $options['stretch'][$v], $headerOptions['ishtml']);
346 $this->SetFillColorArray($this->convertHTMLColorToDec($options['fill']));
352 $this->SetFont($fontFamily,$fontStyle,$fontSize);
353 $this->SetTextColor(0, 0, 0);
357 foreach($item as $k=>$line){
359 $h = $this->getLineHeightFromArray($line, $options["width"]);
360 // in the case when cell height is greater than page height
361 // need to adjust the current page number
362 // so the following output will not overlap the previous output
363 if ($this->getNumPages() != $this->getPage()) {
364 $this->setPage($this->getNumPages());
368 foreach($line as $kk=>$cell){
369 $cellOptions = $options;
373 $value = $cell['value'];
374 if(!empty($cell['options']) && is_array($cell['options'])){
375 $cellOptions = $this->initOptionsForWriteCellTable($cell['options'], $item);
379 //Bug45077-replacing single quote entities
380 $value=str_replace("'","'",$value);
381 //Bug45077-replacing double quote entities
382 $value=str_replace(""",'"',$value);
384 if($even && !empty($options['evencolor'])){
385 $this->SetFillColorArray($this->convertHTMLColorToDec($options['evencolor']));
386 $cellOptions['fillstate']=1;
387 }else if(!$even && !empty($options['oddcolor'])){
388 $this->SetFillColorArray($this->convertHTMLColorToDec($options['oddcolor']));
389 $cellOptions['fillstate']=1;
393 $this->MultiCell($options["width"][$kk],$h,$value,$cellOptions['border'],$cellOptions['align'],$cellOptions['fillstate'],0,'','',true, $options['stretch'][$kk], $cellOptions['ishtml'], true, 0, false);
396 // add page only once (for the first cell)
397 $this->MultiCell($options["width"][$kk],$h,$value,$cellOptions['border'],$cellOptions['align'],$cellOptions['fillstate'],0,'','',true,0,$cellOptions['ishtml'], true, 0, true);
400 $this->MultiCell($options["width"][$kk],$h,$value,$cellOptions['border'],$cellOptions['align'],$cellOptions['fillstate'],0,'','',true,0,$cellOptions['ishtml'], true, 0, false);
404 $this->SetFillColorArray($this->convertHTMLColorToDec($options['fill']));
409 $this->SetFont($fontFamily,$fontStyle,$fontSize);
410 $this->SetTextColor(0, 0, 0);
414 * This method allow printing a table using the writeHTML method with a formatted array in parameter
415 * This method can also return the table as HTML code
416 * @param $item Array[line number (0 to x)][cell header] = Cell content OR
417 * Array[line number (0 to x)][cell header]['value'] = Cell content AND
418 * Array[line number (0 to x)][cell header]['options'] = Array[cell properties] = values
419 * @param $returnHtml (bool) Return the table as HTML code instead of printing the HTML table
420 * @param $options Array which can contain : table (array of "HTML proprty"=>"value"),td (array of "HTML proprty"=>"value"), tr (array of "HTML proprty"=>"value"), isheader(bool), header (array of "HTML proprty"=>"value"), width (array 'column name'=>'width value + unit OR nothing')
421 * @return the HTML code if $returnHtml set to true
423 public function writeHTMLTable($item, $returnHtml=false, $options=NULL){
424 //TODO ISSUE - width in % for the td have to be multiply by the number of column.
425 // ex: for a width of 20% in a table of 6 columns the width will have to be 120% (20*6).
428 if(!empty($options)){
429 foreach($options as $k=>$v){
430 $tmp[strtolower($k)]=$v;
436 if(!isset($options["isheader"]) || $options["isheader"] == true){
437 if(!empty($options["header"])){
438 foreach($options["header"] as $k=>$v){
439 $tmp[strtolower($k)]=$v;
441 $options["header"]=$tmp;
443 $options["header"]=array("tr"=>array("bgcolor"=>"#DCDCDC"),"td"=>array());
446 foreach($item[0] as $k => $v){
447 if(!empty($options["width"]))$options["header"]["td"]["width"]=$options["width"][$k];
448 $line.=$this->wrap("td", $k, $options["header"]);
450 $html.=$this->wrap("tr", $line, $options["header"]);
452 foreach ($item as $k=>$v){
454 foreach($v as $kk => $vv){
455 if(!empty($options["width"]) && isset($options["width"][$kk]))$options["td"]["width"]=$options["width"][$kk];
456 $line.=$this->wrap("td", $vv, $options);
458 $html.=$this->wrap("tr", $line, $options);
460 $html=$this->wrap("table", $html, $options);
464 $this->writeHTML($html);
469 * return the HTML code of the value wrap with the tag $tag. This method handle options (general and specific)
473 * @return the HTML wrapped code
475 private function wrap($tag, $value, $options){
476 if(empty($options[$tag])){
477 $options[$tag] = array();
479 if(is_array($value)){
480 if(isset($value["options"])){
481 // The options of a specific entity overwrite the general options
482 $options[$tag] = $value["options"];
484 if(isset($value["value"])){
485 $value = $value["value"];
490 return wrapTag($tag, $value, $options[$tag]);
494 * Return the heigth of a line depending of the width, the font and the content
495 * @param $line Array containing the data of all the cells of the line
496 * @param $width Array containing the width of all the cells of the line
497 * @return The heigth of the line
499 private function getLineHeightFromArray($line, $width){
501 foreach($line as $kk=>$cell){
503 if(is_array($cellValue)){
504 $tmp = $cellValue['value'];
507 if($h<$this->getNumLines($cellValue, $width[$kk])){
508 $h=$this->getNumLines($cellValue, $width[$kk]);
511 return $h * $this->FontSize * $this->cell_height_ratio + 2 * $this->cMargin;
515 * Private method for writeCellTable which format and initialize the options array.
516 * @param $options array
518 * @return $options array
520 private function initOptionsForWriteCellTable($options, $item){
521 if(!empty($options)){
522 foreach($options as $k=>$v){
523 $tmp[strtolower($k)]=$v;
529 // set to default if empty
530 if(empty($options["width"]) || !is_array($options["width"])){
531 $colNum = count($item[0]);
532 $defaultWidth = $this->getRemainingWidth()/$colNum;
533 foreach($item[0] as $k => $v){
534 $options["width"][$k]=$defaultWidth;
537 foreach($options["width"] as $k => $v){
538 $options["width"][$k] = $this->getHTMLUnitToUnits($v, $this->getRemainingWidth());
543 if(empty($options["border"])){
544 $options["border"]=0;
547 if(empty($options["align"])){
548 $options["align"]="L";
551 if(empty($options['ishtml'])){
552 $options['ishtml'] = false;
554 if(empty($options['border'])){
555 $options['border'] = 0;
557 foreach($item[0] as $k => $v)
558 if (empty($options['stretch'][$k]))
559 $options['stretch'][$k] = self::STRETCH_NONE;
561 if(!empty($options['fill'])){
562 $this->SetFillColorArray($this->convertHTMLColorToDec($options['fill']));
563 $options['fillstate']=1;
565 $options['fill']="#FFFFFF";//white
566 $options['fillstate']=0;
569 if(!empty($options['fontfamily'])){
570 $fontFamily = $options['fontfamily'];
572 $fontFamily = $this->getFontFamily();
574 if(!empty($options['fontsize'])){
575 $fontSize = $options['fontsize'];
577 $fontSize = $this->getFontSizePt();
579 if(!empty($options['fontstyle'])){
580 $fontStyle = $options['fontstyle'];
582 $fontStyle = $this->getFontStyle();
584 if(!empty($options['textcolor'])){
585 $this->SetTextColorArray($this->convertHTMLColorToDec($options['textcolor']));
587 $this->SetTextColor(0, 0, 0);//black
590 $this->SetFont($fontFamily, $fontStyle, $fontSize);
596 * This is method is fix for a better handling of the count. This method now handle the line break
598 * This method returns the estimated number of lines required to print the text.
599 * @param string $txt text to print
600 * @param float $w width of cell. If 0, they extend up to the right margin of the page.
601 * @return int Return the estimated number of lines.
606 public function getNumLines($txt, $w=0) {
608 if (empty($w) OR ($w <= 0)) {
610 $w = $this->x - $this->lMargin;
612 $w = $this->w - $this->rMargin - $this->x;
616 $wmax = $w - (2 * $this->cMargin);
617 // remove carriage returns
618 $txt = str_replace("\r", '', $txt);
619 // divide text in blocks
620 $txtblocks = explode("\n", $txt);
622 foreach ($txtblocks as $block) {
623 // estimate the number of lines
626 // If the block is in more than one line
627 }else if(ceil($this->GetStringWidth($block) / $wmax)>1){
629 $words = explode(" ", $block);
630 //TODO explode with space is not the best things to do...
636 for($i=0; $i<count($words); $i++){
638 $wordBlock = $words[$i];
640 $wordBlock .= " ".$words[$i];
642 if(ceil($this->GetStringWidth($wordBlock) / $wmax)>1){
644 $lastNum = ceil($this->GetStringWidth($wordBlock) / $wmax);
648 if($run && $lastNum == ceil($this->GetStringWidth($wordBlock) / $wmax)){
649 // save the number of line if it is the last loop
650 if($i+1 == count($words)){
651 $lines += ceil($this->GetStringWidth($wordBlock) / $wmax);
656 $lines += ceil($this->GetStringWidth( substr($wordBlock, 0, (strlen($wordBlock) - strlen(" ".$words[$i]))) ) / $wmax);
666 // save the number of line if it is the last loop
667 if($i+1 == count($words)){
668 $lines += ceil($this->GetStringWidth($wordBlock) / $wmax);
680 * Disable zlib output compression if we are downloading the PDF.
682 * @see TCPDF::Output()
684 public function Output($name='doc.pdf', $dest='I')
686 if ( $dest == 'I' || $dest == 'D') {
687 ini_set('zlib.output_compression', 'Off');
690 return parent::Output($name,$dest);