lib/excellib.class.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * excellib.class.php
  20  *
  21  * @copyright  (C) 2001-3001 Eloy Lafuente (stronk7) {@link http://contiento.com}
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  * @package    core
  24  * @subpackage lib
  25  */
  26
  27 defined('MOODLE_INTERNAL') || die();
  28
  29 /** setup.php includes our hacked pear libs first */
  30 require_once 'Spreadsheet/Excel/Writer.php';
  31
  32 /**
  33  * Define and operate over one Moodle Workbook.
  34  *
  35  * A big part of this class acts as a wrapper over the PEAR
  36  * Spreadsheet_Excel_Writer_Workbook and OLE libraries
  37  * maintaining Moodle functions isolated from underlying code.
  38  *
  39  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
  40  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41  * @package moodlecore
  42  */
  43 class MoodleExcelWorkbook {
  44     /** @var object */
  45     var $pear_excel_workbook;
  46     /** @var bool */
  47     var $latin_output;
  48
  49     /**
  50      * Constructs one Moodle Workbook.
  51      *
  52      * @global object
  53      * @param string $filename The name of the file
  54      */
  55     function MoodleExcelWorkbook($filename) {
  56         global $CFG;
  57     /// Internally, create one PEAR Spreadsheet_Excel_Writer_Workbook class
  58         $this->pear_excel_workbook = new Spreadsheet_Excel_Writer($filename);
  59     /// Prepare it to accept UTF-16LE data and to encode it properly
  60         if (empty($CFG->latinexcelexport)) { /// Only if don't want to use latin (win1252) stronger output
  61             $this->pear_excel_workbook->setVersion(8);
  62             $this->latin_output = false;
  63         } else { /// We want latin (win1252) output
  64             $this->latin_output = true;
  65         }
  66     /// Choose our temporary directory - see MDL-7176, found by paulo.matos
  67         make_temp_directory('excel');
  68         $this->pear_excel_workbook->setTempDir($CFG->tempdir.'/excel');
  69     }
  70
  71     /**
  72      * Create one Moodle Worksheet
  73      *
  74      * @param string $name Name of the sheet
  75      * @return object MoodleExcelWorksheet
  76      */
  77     function &add_worksheet($name = '') {
  78     /// Create the Moodle Worksheet. Returns one pointer to it
  79         $ws = new MoodleExcelWorksheet ($name, $this->pear_excel_workbook, $this->latin_output);
  80         return $ws;
  81     }
  82
  83     /**
  84      * Create one Moodle Format
  85      *
  86      * @param array $properties array of properties [name]=value;
  87      *                          valid names are set_XXXX existing
  88      *                          functions without the set_ part
  89      *                          i.e: [bold]=1 for set_bold(1)...Optional!
  90      * @return object MoodleExcelFormat
  91      */
  92     function &add_format($properties = array()) {
  93     /// Create the Moodle Format. Returns one pointer to it
  94         $ft = new MoodleExcelFormat ($this->pear_excel_workbook, $properties);
  95         return $ft;
  96     }
  97
  98     /**
  99      * Close the Moodle Workbook
 100      */
 101     function close() {
 102         $this->pear_excel_workbook->close();
 103     }
 104
 105     /**
 106      * Write the correct HTTP headers
 107      *
 108      * @param string $filename Name of the downloaded file
 109      */
 110     function send($filename) {
 111         $this->pear_excel_workbook->send($filename);
 112     }
 113 }
 114
 115 /**
 116  * Define and operate over one Worksheet.
 117  *
 118  * A big part of this class acts as a wrapper over the PEAR
 119  * Spreadsheet_Excel_Writer_Workbook and OLE libraries
 120  * maintaining Moodle functions isolated from underlying code.
 121  *
 122  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
 123  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 124  * @package moodlecore
 125  */
 126 class MoodleExcelWorksheet {
 127     /** @var object */
 128     var $pear_excel_worksheet;
 129     /** @var bool Only if don't want to use latin (win1252) stronger output */
 130     var $latin_output;
 131
 132     /**
 133      * Constructs one Moodle Worksheet.
 134      *
 135      * @param string $filename The name of the file
 136      * @param object $workbook The internal PEAR Workbook onject we are creating
 137      * @param bool $latin_output Only if don't want to use latin (win1252) stronger output
 138      */
 139     function MoodleExcelWorksheet($name, &$workbook, $latin_output=false) {
 140
 141         if (strlen($name) > 31) {
 142             // Excel does not seem able to cope with sheet names > 31 chars.
 143             // With $latin_output = false, it does not cope at all.
 144             // With $latin_output = true it is supposed to work, but in our experience,
 145             // it doesn't. Therefore, truncate in all circumstances.
 146             $name = textlib::substr($name, 0, 31);
 147         }
 148
 149     /// Internally, add one sheet to the workbook
 150         $this->pear_excel_worksheet =& $workbook->addWorksheet($name);
 151         $this->latin_output = $latin_output;
 152     /// Set encoding to UTF-16LE
 153         if (!$this->latin_output) { /// Only if don't want to use latin (win1252) stronger output
 154             $this->pear_excel_worksheet->setInputEncoding('UTF-16LE');
 155         }
 156     }
 157
 158     /**
 159      * Write one string somewhere in the worksheet
 160      *
 161      * @param integer $row    Zero indexed row
 162      * @param integer $col    Zero indexed column
 163      * @param string  $str    The string to write
 164      * @param mixed   $format The XF format for the cell
 165      */
 166     function write_string($row, $col, $str, $format=null) {
 167     /// Calculate the internal PEAR format
 168         $format = $this->MoodleExcelFormat2PearExcelFormat($format);
 169     /// Convert the text from its original encoding to UTF-16LE
 170         if (!$this->latin_output) { /// Only if don't want to use latin (win1252) stronger output
 171             $str = textlib::convert($str, 'utf-8', 'utf-16le');
 172         } else { /// else, convert to latin (win1252)
 173             $str = textlib::convert($str, 'utf-8', 'windows-1252');
 174         }
 175     /// Add the string safely to the PEAR Worksheet
 176         $this->pear_excel_worksheet->writeString($row, $col, $str, $format);
 177     }
 178
 179     /**
 180      * Write one number somewhere in the worksheet
 181      *
 182      * @param integer $row    Zero indexed row
 183      * @param integer $col    Zero indexed column
 184      * @param float   $num    The number to write
 185      * @param mixed   $format The XF format for the cell
 186      */
 187     function write_number($row, $col, $num, $format=null) {
 188     /// Calculate the internal PEAR format
 189         $format = $this->MoodleExcelFormat2PearExcelFormat($format);
 190     /// Add  the number safely to the PEAR Worksheet
 191         $this->pear_excel_worksheet->writeNumber($row, $col, $num, $format);
 192     }
 193
 194     /**
 195      * Write one url somewhere in the worksheet
 196      *
 197      * @param integer $row    Zero indexed row
 198      * @param integer $col    Zero indexed column
 199      * @param string  $url    The url to write
 200      * @param mixed   $format The XF format for the cell
 201      */
 202     function write_url($row, $col, $url, $format=null) {
 203     /// Calculate the internal PEAR format
 204         $format = $this->MoodleExcelFormat2PearExcelFormat($format);
 205     /// Add  the url safely to the PEAR Worksheet
 206         $this->pear_excel_worksheet->writeUrl($row, $col, $url, $format);
 207     }
 208
 209     /**
 210      * Write one date somewhere in the worksheet
 211      * @param integer $row    Zero indexed row
 212      * @param integer $col    Zero indexed column
 213      * @param string  $date   The date to write in UNIX timestamp format
 214      * @param mixed   $format The XF format for the cell
 215      */
 216     function write_date($row, $col, $date, $format=null) {
 217     /// Calculate the internal PEAR format
 218         $format = $this->MoodleExcelFormat2PearExcelFormat($format);
 219     /// Convert the date to Excel format
 220         $timezone = get_user_timezone_offset();
 221         if ($timezone == 99) {
 222             // system timezone offset in seconds
 223             $offset = (int)date('Z');
 224         } else {
 225             $offset = (int)($timezone * HOURSECS * 2);
 226         }
 227         $value = ((usertime($date) + $offset) / 86400) + 25569;
 228     /// Add  the date safely to the PEAR Worksheet
 229         $this->pear_excel_worksheet->writeNumber($row, $col, $value, $format);
 230     }
 231
 232     /**
 233      * Write one formula somewhere in the worksheet
 234      *
 235      * @param integer $row    Zero indexed row
 236      * @param integer $col    Zero indexed column
 237      * @param string  $formula The formula to write
 238      * @param mixed   $format The XF format for the cell
 239      */
 240     function write_formula($row, $col, $formula, $format=null) {
 241     /// Calculate the internal PEAR format
 242         $format = $this->MoodleExcelFormat2PearExcelFormat($format);
 243     /// Add  the formula safely to the PEAR Worksheet
 244         $this->pear_excel_worksheet->writeFormula($row, $col, $formula, $format);
 245     }
 246
 247     /**
 248      * Write one blanck somewhere in the worksheet
 249      *
 250      * @param integer $row    Zero indexed row
 251      * @param integer $col    Zero indexed column
 252      * @param mixed   $format The XF format for the cell
 253      */
 254     function write_blank($row, $col, $format=null) {
 255     /// Calculate the internal PEAR format
 256         $format = $this->MoodleExcelFormat2PearExcelFormat($format);
 257     /// Add  the blank safely to the PEAR Worksheet
 258         $this->pear_excel_worksheet->writeBlank($row, $col, $format);
 259     }
 260
 261     /**
 262      * Write anything somewhere in the worksheet
 263      * Type will be automatically detected
 264      *
 265      * @param integer $row    Zero indexed row
 266      * @param integer $col    Zero indexed column
 267      * @param mixed   $token  What we are writing
 268      * @param mixed   $format The XF format for the cell
 269      * @return void
 270      */
 271     function write($row, $col, $token, $format=null) {
 272
 273     /// Analyse what are we trying to send
 274         if (preg_match("/^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/", $token)) {
 275         /// Match number
 276             return $this->write_number($row, $col, $token, $format);
 277         } elseif (preg_match("/^[fh]tt?p:\/\//", $token)) {
 278         /// Match http or ftp URL
 279             return $this->write_url($row, $col, $token, '', $format);
 280         } elseif (preg_match("/^mailto:/", $token)) {
 281         /// Match mailto:
 282             return $this->write_url($row, $col, $token, '', $format);
 283         } elseif (preg_match("/^(?:in|ex)ternal:/", $token)) {
 284         /// Match internal or external sheet link
 285             return $this->write_url($row, $col, $token, '', $format);
 286         } elseif (preg_match("/^=/", $token)) {
 287         /// Match formula
 288             return $this->write_formula($row, $col, $token, $format);
 289         } elseif (preg_match("/^@/", $token)) {
 290         /// Match formula
 291             return $this->write_formula($row, $col, $token, $format);
 292         } elseif ($token == '') {
 293         /// Match blank
 294             return $this->write_blank($row, $col, $format);
 295         } else {
 296         /// Default: match string
 297             return $this->write_string($row, $col, $token, $format);
 298         }
 299     }
 300
 301     /**
 302      * Sets the height (and other settings) of one row
 303      *
 304      * @param integer $row    The row to set
 305      * @param integer $height Height we are giving to the row (null to set just format withouth setting the height)
 306      * @param mixed   $format The optional XF format we are giving to the row
 307      * @param bool    $hidden The optional hidden attribute
 308      * @param integer $level  The optional outline level (0-7)
 309      */
 310     function set_row ($row, $height, $format = null, $hidden = false, $level = 0) {
 311     /// Calculate the internal PEAR format
 312         $format = $this->MoodleExcelFormat2PearExcelFormat($format);
 313     /// Set the row safely to the PEAR Worksheet
 314         $this->pear_excel_worksheet->setRow($row, $height, $format, $hidden, $level);
 315     }
 316
 317     /**
 318      * Sets the width (and other settings) of one column
 319      *
 320      * @param integer $firstcol first column on the range
 321      * @param integer $lastcol  last column on the range
 322      * @param integer $width    width to set
 323      * @param mixed   $format   The optional XF format to apply to the columns
 324      * @param integer $hidden   The optional hidden atribute
 325      * @param integer $level    The optional outline level (0-7)
 326      */
 327     function set_column ($firstcol, $lastcol, $width, $format = null, $hidden = false, $level = 0) {
 328     /// Calculate the internal PEAR format
 329         $format = $this->MoodleExcelFormat2PearExcelFormat($format);
 330     /// Set the column safely to the PEAR Worksheet
 331         $this->pear_excel_worksheet->setColumn($firstcol, $lastcol, $width, $format, $hidden, $level);
 332     }
 333
 334     /**
 335     * Set the option to hide gridlines on the printed page.
 336     *
 337     * @access public
 338     */
 339     function hide_gridlines() {
 340         $this->pear_excel_worksheet->hideGridLines();
 341     }
 342
 343     /**
 344     * Set the option to hide gridlines on the worksheet (as seen on the screen).
 345     *
 346     * @access public
 347     */
 348     function hide_screen_gridlines() {
 349         $this->pear_excel_worksheet->hideScreenGridlines();
 350     }
 351
 352     /**
 353     * Insert a 24bit bitmap image in a worksheet.
 354     *
 355     * @access public
 356     * @param integer $row     The row we are going to insert the bitmap into
 357     * @param integer $col     The column we are going to insert the bitmap into
 358     * @param string  $bitmap  The bitmap filename
 359     * @param integer $x       The horizontal position (offset) of the image inside the cell.
 360     * @param integer $y       The vertical position (offset) of the image inside the cell.
 361     * @param integer $scale_x The horizontal scale
 362     * @param integer $scale_y The vertical scale
 363     */
 364     function insert_bitmap($row, $col, $bitmap, $x = 0, $y = 0, $scale_x = 1, $scale_y = 1) {
 365     /// Add the bitmap safely to the PEAR Worksheet
 366         $this->pear_excel_worksheet->insertBitmap($row, $col, $bitmap, $x, $y, $scale_x, $scale_y);
 367     }
 368
 369     /**
 370     * Merges the area given by its arguments.
 371     * This is an Excel97/2000 method. It is required to perform more complicated
 372     * merging than the normal setAlign('merge').
 373     *
 374     * @access public
 375     * @param integer $first_row First row of the area to merge
 376     * @param integer $first_col First column of the area to merge
 377     * @param integer $last_row  Last row of the area to merge
 378     * @param integer $last_col  Last column of the area to merge
 379     */
 380     function merge_cells($first_row, $first_col, $last_row, $last_col) {
 381         /// Merge cells safely to the PEAR Worksheet
 382         $this->pear_excel_worksheet->mergeCells($first_row, $first_col, $last_row, $last_col);
 383     }
 384
 385     /**
 386      * Returns the PEAR Excel Format for one Moodle Excel Format
 387      *
 388      * @param mixed $format MoodleExcelFormat object
 389      * @return mixed PEAR Excel Format object
 390      */
 391     function MoodleExcelFormat2PearExcelFormat($format) {
 392         if ($format) {
 393             return $format->pear_excel_format;
 394         } else {
 395             return null;
 396         }
 397     }
 398 }
 399
 400
 401 /**
 402  * Define and operate over one Format.
 403  *
 404  * A big part of this class acts as a wrapper over the PEAR
 405  * Spreadsheet_Excel_Writer_Workbook and OLE libraries
 406  * maintaining Moodle functions isolated from underlying code.
 407  *
 408  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
 409  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 410  * @package moodlecore
 411  */
 412 class MoodleExcelFormat {
 413     /** @var object */
 414     var $pear_excel_format;
 415
 416     /**
 417      * Constructs one Moodle Format.
 418      *
 419      * @param object $workbook The internal PEAR Workbook onject we are creating
 420      * @param array $properties
 421      */
 422     function MoodleExcelFormat(&$workbook, $properties = array()) {
 423     /// Internally, add one sheet to the workbook
 424         $this->pear_excel_format =& $workbook->addFormat();
 425     /// If we have something in the array of properties, compute them
 426         foreach($properties as $property => $value) {
 427             if(method_exists($this,"set_$property")) {
 428                 $aux = 'set_'.$property;
 429                 $this->$aux($value);
 430             }
 431         }
 432     }
 433
 434     /**
 435      * Set the size of the text in the format (in pixels).
 436      * By default all texts in generated sheets are 10px.
 437      *
 438      * @param integer $size Size of the text (in pixels)
 439      */
 440     function set_size($size) {
 441     /// Set the size safely to the PEAR Format
 442         $this->pear_excel_format->setSize($size);
 443     }
 444
 445     /**
 446      * Set weight of the format
 447      *
 448      * @param integer $weight Weight for the text, 0 maps to 400 (normal text),
 449      *                        1 maps to 700 (bold text). Valid range is: 100-1000.
 450      *                        It's Optional, default is 1 (bold).
 451      */
 452     function set_bold($weight = 1) {
 453     /// Set the bold safely to the PEAR Format
 454         $this->pear_excel_format->setBold($weight);
 455     }
 456
 457     /**
 458      * Set underline of the format
 459      *
 460      * @param integer $underline The value for underline. Possible values are:
 461      *                           1 => underline, 2 => double underline
 462      */
 463     function set_underline($underline) {
 464     /// Set the underline safely to the PEAR Format
 465         $this->pear_excel_format->setUnderline($underline);
 466     }
 467
 468     /**
 469      * Set italic of the format
 470      */
 471     function set_italic() {
 472     /// Set the italic safely to the PEAR Format
 473         $this->pear_excel_format->setItalic();
 474     }
 475
 476     /**
 477      * Set strikeout of the format
 478      */
 479     function set_strikeout() {
 480     /// Set the strikeout safely to the PEAR Format
 481         $this->pear_excel_format->setStrikeOut();
 482     }
 483
 484     /**
 485      * Set outlining of the format
 486      */
 487     function set_outline() {
 488     /// Set the outlining safely to the PEAR Format
 489         $this->pear_excel_format->setOutLine();
 490     }
 491
 492     /**
 493      * Set shadow of the format
 494      */
 495     function set_shadow() {
 496     /// Set the shadow safely to the PEAR Format
 497         $this->pear_excel_format->setShadow();
 498     }
 499
 500     /**
 501      * Set the script of the text
 502      *
 503      * @param integer $script The value for script type. Possible values are:
 504      *                        1 => superscript, 2 => subscript
 505      */
 506     function set_script($script) {
 507     /// Set the script safely to the PEAR Format
 508         $this->pear_excel_format->setScript($script);
 509     }
 510
 511     /**
 512      * Set color of the format. Used to specify the color of the text to be formatted.
 513      *
 514      * @param mixed $color either a string (like 'blue'), or an integer (range is [8...63])
 515      */
 516     function set_color($color) {
 517     /// Set the background color safely to the PEAR Format
 518         $this->pear_excel_format->setColor($color);
 519     }
 520
 521     /**
 522      * Set foreground color (top layer) of the format. About formatting colors note that cells backgrounds
 523      * have TWO layers, in order to support patterns and paint them with two diferent colors.
 524      * This method set the color of the TOP layer of the background format. So, when filling
 525      * cells with plain colors (no patterns) this is the method to use.
 526      *
 527      * @param mixed $color either a string (like 'blue'), or an integer (range is [8...63])
 528      */
 529     function set_fg_color($color) {
 530     /// Set the foreground color safely to the PEAR Format
 531         $this->pear_excel_format->setFgColor($color);
 532     }
 533
 534     /**
 535      * Set background color (bottom layer) of the format. About formatting colors note that cells backgrounds
 536      * have TWO layers, in order to support patterns and paint them with two diferent colors.
 537      * This method set the color of the BOTTOM layer of the background format. So, the color
 538      * specified here only will be visible if using patterns. Use set_fg_color() to fill
 539      * cells with plain colors (no patterns).
 540      *
 541      * @param mixed $color either a string (like 'blue'), or an integer (range is [8...63])
 542      */
 543     function set_bg_color($color) {
 544     /// Set the background color safely to the PEAR Format
 545         $this->pear_excel_format->setBgColor($color);
 546     }
 547
 548     /**
 549      * Set the fill pattern of the format
 550      * @param integer Optional. Defaults to 1. Meaningful values are: 0-18
 551      *                0 meaning no background.
 552      */
 553     function set_pattern($pattern=1) {
 554     /// Set the fill pattern safely to the PEAR Format
 555         $this->pear_excel_format->setPattern($pattern);
 556     }
 557
 558     /**
 559      * Set text wrap of the format
 560      */
 561     function set_text_wrap() {
 562     /// Set the shadow safely to the PEAR Format
 563         $this->pear_excel_format->setTextWrap();
 564     }
 565
 566     /**
 567      * Set the cell alignment of the format
 568      *
 569      * @param string $location alignment for the cell ('left', 'right', etc...)
 570      */
 571     function set_align($location) {
 572     /// Set the alignment of the cell safely to the PEAR Format
 573         $this->pear_excel_format->setAlign($location);
 574     }
 575
 576     /**
 577      * Set the cell horizontal alignment of the format
 578      *
 579      * @param string $location alignment for the cell ('left', 'right', etc...)
 580      */
 581     function set_h_align($location) {
 582     /// Set the alignment of the cell safely to the PEAR Format
 583         $this->pear_excel_format->setHAlign($location);
 584     }
 585
 586     /**
 587      * Set the cell vertical alignment of the format
 588      *
 589      * @param string $location alignment for the cell ('top', 'vleft', etc...)
 590      */
 591     function set_v_align($location) {
 592     /// Set the alignment of the cell safely to the PEAR Format
 593         $this->pear_excel_format->setVAlign($location);
 594     }
 595
 596     /**
 597      * Set the top border of the format
 598      *
 599      * @param integer $style style for the cell. 1 => thin, 2 => thick
 600      */
 601     function set_top($style) {
 602     /// Set the top border of the cell safely to the PEAR Format
 603         $this->pear_excel_format->setTop($style);
 604     }
 605
 606     /**
 607      * Set the bottom border of the format
 608      *
 609      * @param integer $style style for the cell. 1 => thin, 2 => thick
 610      */
 611     function set_bottom($style) {
 612     /// Set the bottom border of the cell safely to the PEAR Format
 613         $this->pear_excel_format->setBottom($style);
 614     }
 615
 616     /**
 617      * Set the left border of the format
 618      *
 619      * @param integer $style style for the cell. 1 => thin, 2 => thick
 620      */
 621     function set_left($style) {
 622     /// Set the left border of the cell safely to the PEAR Format
 623         $this->pear_excel_format->setLeft($style);
 624     }
 625
 626     /**
 627      * Set the right border of the format
 628      *
 629      * @param integer $style style for the cell. 1 => thin, 2 => thick
 630      */
 631     function set_right($style) {
 632     /// Set the right border of the cell safely to the PEAR Format
 633         $this->pear_excel_format->setRight($style);
 634     }
 635
 636     /**
 637      * Set cells borders to the same style
 638      *
 639      * @param integer $style style to apply for all cell borders. 1 => thin, 2 => thick.
 640      */
 641     function set_border($style) {
 642     /// Set all the borders of the cell safely to the PEAR Format
 643         $this->pear_excel_format->setBorder($style);
 644     }
 645
 646     /**
 647      * Set the numerical format of the format
 648      * It can be date, time, currency, etc...
 649      *
 650      * @param integer $num_format The numeric format
 651      */
 652     function set_num_format($num_format) {
 653     /// Set the numerical format safely to the PEAR Format
 654         $this->pear_excel_format->setNumFormat($num_format);
 655     }
 656
 657 }