├── tests ├── images │ ├── php.gif │ ├── mysql.gif │ ├── anaska.gif │ ├── anaska.jpg │ └── apache.gif ├── tutoriel1.odt ├── tutoriel1.php ├── tutoriel2.odt ├── tutoriel2.php ├── tutoriel3.odt ├── tutoriel3.php ├── tutoriel4.odt ├── tutoriel4.php ├── tutoriel5.odt ├── tutoriel5.php ├── tutoriel6.odt ├── tutoriel6.php ├── tutoriel7.odt ├── tutoriel7.php ├── simplecheck.odt ├── tutorial1.php └── simplecheck.php ├── exemple_form ├── formulaire_template.odt ├── README.md └── formulaire.php ├── documentation └── odtphp_documentation.pdf ├── src ├── Exceptions │ ├── OdfException.php │ ├── SegmentException.php │ ├── PclZipProxyException.php │ └── PhpZipProxyException.php ├── SegmentIterator.php ├── Zip │ ├── ZipInterface.php │ ├── PhpZipProxy.php │ └── PclZipProxy.php ├── Segment.php └── Odf.php ├── .gitignore ├── README.fr.md ├── composer.json ├── README.md └── LICENSE /tests/images/php.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/images/php.gif -------------------------------------------------------------------------------- /tests/tutoriel1.odt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel1.odt -------------------------------------------------------------------------------- /tests/tutoriel1.php: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel1.php -------------------------------------------------------------------------------- /tests/tutoriel2.odt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel2.odt -------------------------------------------------------------------------------- /tests/tutoriel2.php: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel2.php -------------------------------------------------------------------------------- /tests/tutoriel3.odt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel3.odt -------------------------------------------------------------------------------- /tests/tutoriel3.php: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel3.php -------------------------------------------------------------------------------- /tests/tutoriel4.odt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel4.odt -------------------------------------------------------------------------------- /tests/tutoriel4.php: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel4.php -------------------------------------------------------------------------------- /tests/tutoriel5.odt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel5.odt -------------------------------------------------------------------------------- /tests/tutoriel5.php: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel5.php -------------------------------------------------------------------------------- /tests/tutoriel6.odt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel6.odt -------------------------------------------------------------------------------- /tests/tutoriel6.php: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel6.php -------------------------------------------------------------------------------- /tests/tutoriel7.odt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel7.odt -------------------------------------------------------------------------------- /tests/tutoriel7.php: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/tutoriel7.php -------------------------------------------------------------------------------- /tests/images/mysql.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/images/mysql.gif -------------------------------------------------------------------------------- /tests/simplecheck.odt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/simplecheck.odt -------------------------------------------------------------------------------- /tests/images/anaska.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/images/anaska.gif -------------------------------------------------------------------------------- /tests/images/anaska.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/images/anaska.jpg -------------------------------------------------------------------------------- /tests/images/apache.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/tests/images/apache.gif -------------------------------------------------------------------------------- /exemple_form/formulaire_template.odt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/exemple_form/formulaire_template.odt -------------------------------------------------------------------------------- /documentation/odtphp_documentation.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cybermonde/odtphp/HEAD/documentation/odtphp_documentation.pdf -------------------------------------------------------------------------------- /src/Exceptions/OdfException.php: -------------------------------------------------------------------------------- 1 | =5.2.4" 13 | }, 14 | "require-dev": { 15 | "phpunit/phpunit" : "4.*", 16 | "scrutinizer/ocular": "~1.1", 17 | "symfony/var-dumper": "^2.7" 18 | }, 19 | "autoload": { 20 | "psr-4": { 21 | "Odtphp\\": "src" 22 | }, 23 | "files": ["lib/pclzip.lib.php"] 24 | }, 25 | "autoload-dev": { 26 | "psr-4": { 27 | "Odtphp\\Test\\": "tests" 28 | }, 29 | "files": ["lib/pclzip.lib.php"] 30 | }, 31 | "extra": { 32 | "branch-alias": { 33 | "dev-master": "2.0-dev" 34 | } 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | odtphp 2 | ====== 3 | 4 | ### Original description 5 | 6 | OdtPHP is a library to quickly generate Open Document Text-files that can be read by a [gigantic set][3] of Office Suites, including LibreOffice, OpenOffice and even Microsoft Office from PHP code. It uses a simple templating mechanism. 7 | See the tests/ folder for a set of examples. 8 | 9 | This repository already includes the changes suggested by [Vikas Mahajan][1] and a number of other bug fixes. 10 | 11 | ### History 12 | 13 | This project was initially started by Julien Pauli, Olivier Booklage, Vincent Brouté and published at [http://www.odtphp.com][2] (link leads to archived version of page, as it is not available any longer). 14 | 15 | ### Links: 16 | 17 | * http://sourceforge.net/projects/odtphp/ Sourceforge Project of the initial library (stale) 18 | 19 | [1]: http://vikasmahajan.wordpress.com/2010/12/09/odtphp-bug-solved/ 20 | [2]: https://web.archive.org/web/20120531095719/http://www.odtphp.com/index.php?i=home 21 | [3]: https://en.wikipedia.org/wiki/OpenDocument_software#Text_documents_.28.odt.29 -------------------------------------------------------------------------------- /tests/tutorial1.php: -------------------------------------------------------------------------------- 1 | setVars('titre', 'PHP: Hypertext PreprocessorPHP: Hypertext Preprocessor'); 26 | 27 | $message = "PHP (sigle de PHP: Hypertext Preprocessor), est un langage de scripts libre 28 | principalement utilisé pour produire des pages Web dynamiques via un serveur HTTP, mais 29 | pouvant également fonctionner comme n'importe quel langage interprété de façon locale, 30 | en exécutant les programmes en ligne de commande."; 31 | 32 | $odf->setVars('message', $message); 33 | 34 | // We export the file 35 | $odf->exportAsAttachedFile(); 36 | -------------------------------------------------------------------------------- /src/SegmentIterator.php: -------------------------------------------------------------------------------- 1 | ref = $ref; 27 | $this->key = 0; 28 | $this->keys = array_keys($this->ref); 29 | } 30 | 31 | public function hasChildren() 32 | { 33 | return $this->valid() && $this->current() instanceof Segment; 34 | } 35 | 36 | public function current() 37 | { 38 | return $this->ref[$this->keys[$this->key]]; 39 | } 40 | 41 | public function getChildren() 42 | { 43 | return new self($this->current()->children); 44 | } 45 | 46 | public function key() 47 | { 48 | return $this->key; 49 | } 50 | 51 | public function valid() 52 | { 53 | return array_key_exists($this->key, $this->keys); 54 | } 55 | 56 | public function rewind() 57 | { 58 | $this->key = 0; 59 | } 60 | 61 | public function next() 62 | { 63 | $this->key ++; 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /src/Zip/ZipInterface.php: -------------------------------------------------------------------------------- 1 | 18 | 19 | 20 | 21 | Formulaire vers ODT 22 | 23 | 25 | 26 | 27 |
28 |

29 | Mme 30 | M. 31 |

32 |

33 | 34 | 35 |

36 |

37 | 38 | 39 |

40 |

41 | 42 | 43 |

44 |

45 | 46 |

47 |
48 | 49 | 50 | setVars('cyb_date', date("d/m/Y")); 55 | // données du formulaire 56 | $odf->setVars('cyb_invite', $_POST["invite"]); 57 | // gestion des accents via cet artifice html_entity_decode(htmlentities(... 58 | $odf->setVars('cyb_prenom', html_entity_decode(htmlentities($_POST["prenom"],ENT_NOQUOTES, "utf-8"))); 59 | $odf->setVars('cyb_nom', html_entity_decode(htmlentities($_POST["nom"],ENT_NOQUOTES, "utf-8"))); 60 | $odf->setVars('cyb_total', $_POST["total"]); 61 | // création du fichier 62 | $odf->exportAsAttachedFile(); 63 | } 64 | ?> 65 | -------------------------------------------------------------------------------- /src/Zip/PhpZipProxy.php: -------------------------------------------------------------------------------- 1 | zipArchive = new ZipArchive(); 39 | } 40 | 41 | /** 42 | * Open a Zip archive 43 | * 44 | * @param string $filename the name of the archive to open 45 | * @return true if openning has succeeded 46 | */ 47 | public function open($filename) 48 | { 49 | $this->filename = $filename; 50 | return $this->zipArchive->open($filename, ZIPARCHIVE::CREATE); 51 | } 52 | 53 | /** 54 | * Retrieve the content of a file within the archive from its name 55 | * 56 | * @param string $name the name of the file to extract 57 | * @return the content of the file in a string 58 | */ 59 | public function getFromName($name) 60 | { 61 | return $this->zipArchive->getFromName($name); 62 | } 63 | 64 | /** 65 | * Add a file within the archive from a string 66 | * 67 | * @param string $localname the local path to the file in the archive 68 | * @param string $contents the content of the file 69 | * @return true if the file has been successful added 70 | */ 71 | public function addFromString($localname, $contents) 72 | { 73 | if (file_exists($this->filename) && !is_writable($this->filename)) { 74 | return false; 75 | } 76 | return $this->zipArchive->addFromString($localname, $contents); 77 | } 78 | 79 | /** 80 | * Add a file within the archive from a file 81 | * 82 | * @param string $filename the path to the file we want to add 83 | * @param string $localname the local path to the file in the archive 84 | * @return true if the file has been successful added 85 | */ 86 | public function addFile($filename, $localname = null) 87 | { 88 | if ((file_exists($this->filename) && !is_writable($this->filename)) 89 | || !file_exists($filename)) { 90 | return false; 91 | } 92 | return $this->zipArchive->addFile($filename, $localname); 93 | } 94 | 95 | /** 96 | * Close the Zip archive 97 | * @return true 98 | */ 99 | public function close() 100 | { 101 | return $this->zipArchive->close(); 102 | } 103 | } 104 | -------------------------------------------------------------------------------- /tests/simplecheck.php: -------------------------------------------------------------------------------- 1 | open($filename) !== true ) 43 | { 44 | throw new OdfException("Error while Opening the file '$filename' - Check your odt file"); 45 | } 46 | 47 | // read content.xml from the oasis document 48 | 49 | if (($contentXml = $file->getFromName('content.xml')) === false) 50 | { 51 | throw new OdfException("Nothing to parse - check that the content.xml file is correctly formed"); 52 | } 53 | 54 | // close the original oasis document 55 | 56 | $file->close(); 57 | 58 | // for futur use, with load content.xml via DOMDocument library : 59 | 60 | $odt_content = new DOMDocument('1.0', 'utf-8'); 61 | if ($odt_content->loadXML( $contentXml ) == FALSE) 62 | { 63 | throw new OdfException('Unable to load content.xml by DOMDocument library ', __METHOD__); 64 | } 65 | 66 | // here, we dont use the temp function but local temporary file 67 | 68 | $tmpfile = md5(uniqid()).'.odt'; 69 | if( !@copy($filename, $tmpfile) ); 70 | { 71 | // we do not test, because sometime it return false anyway !! 72 | // $errors = error_get_last(); 73 | // throw new OdfException("Can not copy the tempfile in $tmpfile :[".$errors['message'] ."]/[".$errors['type']."]"); 74 | } 75 | 76 | // futur use here : $odt_content modifications ... 77 | 78 | 79 | 80 | 81 | // open the temporary zipfile 82 | 83 | if( $file->open($tmpfile, ZIPARCHIVE::CREATE) != TRUE ) 84 | { 85 | @unlink($tmpfile); // erase temporary file 86 | throw new OdfException("Error while Opening the tempfile '$tmpfile' - Check your odt file"); 87 | } 88 | 89 | // for futur use here : with overwrite content.xml in zip file via DOMDocument library : 90 | 91 | if (! $file->addFromString('content.xml', $odt_content->saveXML()) ) 92 | { 93 | @unlink($tmpfile); // erase temporary file 94 | throw new OdfException('Error during file export'); 95 | } 96 | 97 | // close the temporary zipfile 98 | 99 | $file->close(); 100 | 101 | // send the new checkresult.odt file via http : 102 | 103 | $name = "checkresult.odt"; 104 | $size = filesize($tmpfile); 105 | header('Content-type: application/vnd.oasis.opendocument.text'); 106 | header('Content-Disposition: attachment; filename="'.$name.'"'); 107 | header("Content-Length: ".$size); 108 | readfile($tmpfile); // output 109 | @unlink($tmpfile); // erase temporary file 110 | exit; // be sure nothing else is write after 111 | 112 | ?> -------------------------------------------------------------------------------- /src/Zip/PclZipProxy.php: -------------------------------------------------------------------------------- 1 | openned) { 48 | $this->close(); 49 | } 50 | if (!file_exists(self::TMP_DIR)) { 51 | mkdir(self::TMP_DIR); 52 | } 53 | $this->filename = $filename; 54 | $this->pclzip = new \PclZip($this->filename); 55 | $this->openned = true; 56 | return true; 57 | } 58 | 59 | /** 60 | * Retrieve the content of a file within the archive from its name 61 | * 62 | * @param string $name the name of the file to extract 63 | * @return the content of the file in a string 64 | */ 65 | public function getFromName($name) 66 | { 67 | if (false === $this->openned) { 68 | return false; 69 | } 70 | $name = preg_replace("/(?:\.|\/)*(.*)/", "\\1", $name); 71 | $extraction = $this->pclzip->extract(PCLZIP_OPT_BY_NAME, $name, PCLZIP_OPT_EXTRACT_AS_STRING); 72 | if (!empty($extraction)) { 73 | return $extraction[0]['content']; 74 | } 75 | return false; 76 | } 77 | 78 | /** 79 | * Add a file within the archive from a string 80 | * 81 | * @param string $localname the local path to the file in the archive 82 | * @param string $contents the content of the file 83 | * @return true if the file has been successful added 84 | */ 85 | public function addFromString($localname, $contents) 86 | { 87 | if (false === $this->openned) { 88 | return false; 89 | } 90 | if (file_exists($this->filename) && !is_writable($this->filename)) { 91 | return false; 92 | } 93 | $localname = preg_replace("/(?:\.|\/)*(.*)/", "\\1", $localname); 94 | $localpath = dirname($localname); 95 | $tmpfilename = self::TMP_DIR . '/' . basename($localname); 96 | if (false !== file_put_contents($tmpfilename, $contents)) { 97 | $this->pclzip->delete(PCLZIP_OPT_BY_NAME, $localname); 98 | $add = $this->pclzip->add($tmpfilename, PCLZIP_OPT_REMOVE_PATH, self::TMP_DIR, PCLZIP_OPT_ADD_PATH, $localpath); 99 | unlink($tmpfilename); 100 | if (!empty($add)) { 101 | return true; 102 | } 103 | } 104 | return false; 105 | } 106 | 107 | /** 108 | * Add a file within the archive from a file 109 | * 110 | * @param string $filename the path to the file we want to add 111 | * @param string $localname the local path to the file in the archive 112 | * @return true if the file has been successful added 113 | */ 114 | public function addFile($filename, $localname = null) 115 | { 116 | if (false === $this->openned) { 117 | return false; 118 | } 119 | if ((file_exists($this->filename) && !is_writable($this->filename)) 120 | || !file_exists($filename)) { 121 | return false; 122 | } 123 | if (isset($localname)) { 124 | $localname = preg_replace("/(?:\.|\/)*(.*)/", "\\1", $localname); 125 | $localpath = dirname($localname); 126 | $tmpfilename = self::TMP_DIR . '/' . basename($localname); 127 | } else { 128 | $localname = basename($filename); 129 | $tmpfilename = self::TMP_DIR . '/' . $localname; 130 | $localpath = ''; 131 | } 132 | if (file_exists($filename)) { 133 | copy($filename, $tmpfilename); 134 | $this->pclzip->delete(PCLZIP_OPT_BY_NAME, $localname); 135 | $this->pclzip->add($tmpfilename, PCLZIP_OPT_REMOVE_PATH, self::TMP_DIR, PCLZIP_OPT_ADD_PATH, $localpath); 136 | unlink($tmpfilename); 137 | return true; 138 | } 139 | return false; 140 | } 141 | 142 | /** 143 | * Close the Zip archive 144 | * @return true 145 | */ 146 | public function close() 147 | { 148 | if (false === $this->openned) { 149 | return false; 150 | } 151 | $this->pclzip = $this->filename = null; 152 | $this->openned = false; 153 | if (file_exists(self::TMP_DIR)) { 154 | $this->_rrmdir(self::TMP_DIR); 155 | rmdir(self::TMP_DIR); 156 | } 157 | return true; 158 | } 159 | 160 | /** 161 | * Empty the temporary working directory recursively 162 | * @param $dir the temporary working directory 163 | * @return void 164 | */ 165 | private function _rrmdir($dir) 166 | { 167 | if ($handle = opendir($dir)) { 168 | while (false !== ($file = readdir($handle))) { 169 | if ($file != '.' && $file != '..') { 170 | if (is_dir($dir . '/' . $file)) { 171 | $this->_rrmdir($dir . '/' . $file); 172 | rmdir($dir . '/' . $file); 173 | } else { 174 | unlink($dir . '/' . $file); 175 | } 176 | } 177 | } 178 | closedir($handle); 179 | } 180 | } 181 | } 182 | -------------------------------------------------------------------------------- /src/Segment.php: -------------------------------------------------------------------------------- 1 | name = (string) $name; 43 | $this->xml = (string) $xml; 44 | $this->odf = $odf; 45 | $zipHandler = $this->odf->getConfig('ZIP_PROXY'); 46 | $this->file = new $zipHandler(); 47 | $this->_analyseChildren($this->xml); 48 | } 49 | 50 | /** 51 | * Returns the name of the segment 52 | * 53 | * @return string 54 | */ 55 | public function getName() 56 | { 57 | return $this->name; 58 | } 59 | 60 | /** 61 | * Does the segment have children ? 62 | * 63 | * @return bool 64 | */ 65 | public function hasChildren() 66 | { 67 | return $this->getIterator()->hasChildren(); 68 | } 69 | 70 | /** 71 | * Countable interface 72 | * 73 | * @return int 74 | */ 75 | public function count() 76 | { 77 | return count($this->children); 78 | } 79 | 80 | /** 81 | * IteratorAggregate interface 82 | * 83 | * @return Iterator 84 | */ 85 | public function getIterator() 86 | { 87 | return new \RecursiveIteratorIterator(new SegmentIterator($this->children), 1); 88 | } 89 | 90 | /** 91 | * Replace variables of the template in the XML code 92 | * All the children are also called 93 | * 94 | * @return string 95 | */ 96 | public function merge() 97 | { 98 | $this->xmlParsed .= str_replace(array_keys($this->vars), array_values($this->vars), $this->xml); 99 | if ($this->hasChildren()) { 100 | foreach ($this->children as $child) { 101 | $this->xmlParsed = str_replace($child->xml, ($child->xmlParsed=="")?$child->merge():$child->xmlParsed, $this->xmlParsed); 102 | $child->xmlParsed = ''; 103 | //Store all image names used in child segments in current segment array 104 | foreach ($child->manif_vars as $file) { 105 | $this->manif_vars[] = $file; 106 | } 107 | 108 | $child->manif_vars = array(); 109 | } 110 | } 111 | $reg = "/\[!--\sBEGIN\s$this->name\s--\](.*)\[!--\sEND\s$this->name\s--\]/smU"; 112 | $this->xmlParsed = preg_replace($reg, '$1', $this->xmlParsed); 113 | $this->file->open($this->odf->getTmpfile()); 114 | foreach ($this->images as $imageKey => $imageValue) { 115 | if ($this->file->getFromName('Pictures/' . $imageValue) === false) { 116 | $this->file->addFile($imageKey, 'Pictures/' . $imageValue); 117 | } 118 | } 119 | 120 | $this->file->close(); 121 | return $this->xmlParsed; 122 | } 123 | 124 | /** 125 | * Analyse the XML code in order to find children 126 | * 127 | * @param string $xml 128 | * @return Segment 129 | */ 130 | protected function _analyseChildren($xml) 131 | { 132 | // $reg2 = "#\[!--\sBEGIN\s([\S]*)\s--\](?:<\/text:p>)?(.*)(?:)?\[!--\sEND\s(\\1)\s--\]#sm"; 133 | $reg2 = "#\[!--\sBEGIN\s([\S]*)\s--\](.*)\[!--\sEND\s(\\1)\s--\]#smU"; 134 | preg_match_all($reg2, $xml, $matches); 135 | for ($i = 0, $size = count($matches[0]); $i < $size; $i++) { 136 | if ($matches[1][$i] != $this->name) { 137 | $this->children[$matches[1][$i]] = new self($matches[1][$i], $matches[0][$i], $this->odf); 138 | } else { 139 | $this->_analyseChildren($matches[2][$i]); 140 | } 141 | } 142 | return $this; 143 | } 144 | 145 | /** 146 | * Assign a template variable to replace 147 | * 148 | * @param string $key 149 | * @param string $value 150 | * @throws SegmentException 151 | * @return Segment 152 | */ 153 | public function setVars($key, $value, $encode = true, $charset = 'ISO-8859') 154 | { 155 | if (strpos($this->xml, $this->odf->getConfig('DELIMITER_LEFT') . $key . $this->odf->getConfig('DELIMITER_RIGHT')) === false) { 156 | throw new SegmentException("var $key not found in {$this->getName()}"); 157 | } 158 | $value = $encode ? htmlspecialchars($value) : $value; 159 | $value = ($charset == 'ISO-8859') ? utf8_encode($value) : $value; 160 | $this->vars[$this->odf->getConfig('DELIMITER_LEFT') . $key . $this->odf->getConfig('DELIMITER_RIGHT')] = str_replace("\n", "", $value); 161 | return $this; 162 | } 163 | 164 | /** 165 | * Assign a template variable as a picture 166 | * 167 | * @param string $key name of the variable within the template 168 | * @param string $value path to the picture 169 | * @param string $page anchor to page number (or -1 if anchor-type is aschar) 170 | * @param string $width width of picture (keep original if null) 171 | * @param string $height height of picture (keep original if null) 172 | * @param string $offsetX offset by horizontal (not used if $page = -1) 173 | * @param string $offsetY offset by vertical (not used if $page = -1) 174 | * @throws OdfException 175 | * @return Segment 176 | */ 177 | public function setImage($key, $value, $page = null, $width = null, $height = null, $offsetX = null, $offsetY = null) 178 | { 179 | $filename = strtok(strrchr($value, '/'), '/.'); 180 | $file = substr(strrchr($value, '/'), 1); 181 | $size = @getimagesize($value); 182 | if ($size === false) { 183 | throw new OdfException("Invalid image"); 184 | } 185 | if (!$width && !$height) { 186 | list ($width, $height) = $size; 187 | $width *= Odf::PIXEL_TO_CM; 188 | $height *= Odf::PIXEL_TO_CM; 189 | } 190 | $anchor = $page == -1 ? 'text:anchor-type="aschar"' : "text:anchor-type=\"page\" text:anchor-page-number=\"{$page}\" svg:x=\"{$offsetX}cm\" svg:y=\"{$offsetY}cm\""; 191 | $xml = << 193 | IMG; 194 | $this->images[$value] = $file; 195 | $this->manif_vars[] = $file; //save image name as array element 196 | $this->setVars($key, $xml, false); 197 | return $this; 198 | } 199 | 200 | /** 201 | * Shortcut to retrieve a child 202 | * 203 | * @param string $prop 204 | * @return Segment 205 | * @throws SegmentException 206 | */ 207 | public function __get($prop) 208 | { 209 | if (array_key_exists($prop, $this->children)) { 210 | return $this->children[$prop]; 211 | } else { 212 | throw new SegmentException('child ' . $prop . ' does not exist'); 213 | } 214 | } 215 | 216 | /** 217 | * Proxy for setVars 218 | * 219 | * @param string $meth 220 | * @param array $args 221 | * @return Segment 222 | */ 223 | public function __call($meth, $args) 224 | { 225 | try { 226 | array_unshift($args, $meth); 227 | return call_user_func_array(array($this, 'setVars'), $args); 228 | } catch (SegmentException $e) { 229 | throw new SegmentException("method $meth nor var $meth exist"); 230 | } 231 | } 232 | 233 | /** 234 | * Returns the parsed XML 235 | * 236 | * @return string 237 | */ 238 | public function getXmlParsed() 239 | { 240 | return $this->xmlParsed; 241 | } 242 | } 243 | -------------------------------------------------------------------------------- /src/Odf.php: -------------------------------------------------------------------------------- 1 | 'Odtphp\\Zip\\PclZipProxy', 29 | 'DELIMITER_LEFT' => '{', 30 | 'DELIMITER_RIGHT' => '}', 31 | 'PATH_TO_TMP' => null 32 | ); 33 | protected $file; 34 | protected $contentXml; // To store content of content.xml file 35 | protected $manifestXml; // To store content of manifest.xml file 36 | protected $stylesXml; // To store content of styles.xml file 37 | protected $tmpfile; 38 | protected $images = array(); 39 | protected $vars = array(); 40 | protected $manif_vars = array(); // array to store image names 41 | protected $segments = array(); 42 | const PIXEL_TO_CM = 0.026458333; 43 | 44 | /** 45 | * Class constructor 46 | * 47 | * @param string $filename the name of the odt file 48 | * @throws OdfException 49 | */ 50 | public function __construct($filename, $config = array()) 51 | { 52 | if (!is_array($config)) { 53 | throw new OdfException('Configuration data must be provided as array'); 54 | } 55 | foreach ($config as $configKey => $configValue) { 56 | if (array_key_exists($configKey, $this->config)) { 57 | $this->config[$configKey] = $configValue; 58 | } 59 | } 60 | if (!class_exists($this->config['ZIP_PROXY'])) { 61 | throw new OdfException($this->config['ZIP_PROXY'] . ' class not found - check your php settings'); 62 | } 63 | $zipHandler = $this->config['ZIP_PROXY']; 64 | $this->file = new $zipHandler(); 65 | if ($this->file->open($filename) !== true) { 66 | throw new OdfException("Error while Opening the file '$filename' - Check your odt file"); 67 | } 68 | if (($this->contentXml = $this->file->getFromName('content.xml')) === false) { 69 | throw new OdfException("Nothing to parse - check that the content.xml file is correctly formed"); 70 | } 71 | if (($this->stylesXml = $this->file->getFromName('styles.xml')) === false) { 72 | throw new OdfException("Nothing to parse - Check that the styles.xml file is correctly formed in source file '$filename'"); 73 | } 74 | if (($this->manifestXml = $this->file->getFromName('META-INF/manifest.xml')) === false) { 75 | throw new OdfException("Something is wrong with META-INF/manifest.xm in source file '$filename'"); 76 | } 77 | 78 | $this->file->close(); 79 | 80 | $tmp = tempnam($this->config['PATH_TO_TMP'], md5(uniqid())); 81 | copy($filename, $tmp); 82 | $this->tmpfile = $tmp; 83 | $this->_moveRowSegments(); 84 | } 85 | 86 | /** 87 | * Delete the temporary file when the object is destroyed 88 | */ 89 | public function __destruct() 90 | { 91 | if (file_exists($this->tmpfile)) { 92 | unlink($this->tmpfile); 93 | } 94 | } 95 | 96 | /** 97 | * Assing a template variable 98 | * 99 | * @param string $key name of the variable within the template 100 | * @param string $value replacement value 101 | * @param bool $encode if true, special XML characters are encoded 102 | * @throws OdfException 103 | * @return odf 104 | */ 105 | public function setVars($key, $value, $encode = true, $charset = 'ISO-8859') 106 | { 107 | $tag= $this->config['DELIMITER_LEFT'] . $key . $this->config['DELIMITER_RIGHT']; 108 | if (strpos($this->contentXml, $tag) === false && strpos($this->stylesXml, $tag) === false) { 109 | throw new OdfException("var $key not found in the document"); 110 | } 111 | $value = $encode ? $this->recursiveHtmlspecialchars($value) : $value; 112 | $value = ($charset == 'ISO-8859') ? utf8_encode($value) : $value; 113 | $this->vars[$tag] = str_replace("\n", "", $value); 114 | return $this; 115 | } 116 | 117 | /** 118 | * Assign a template variable as a picture 119 | * 120 | * @param string $key name of the variable within the template 121 | * @param string $value path to the picture 122 | * @param integer $page anchor to page number (or -1 if anchor-type is as-char) 123 | * @param integer $width width of picture (keep original if null) 124 | * @param integer $height height of picture (keep original if null) 125 | * @param integer $offsetX offset by horizontal (not used if $page = -1) 126 | * @param integer $offsetY offset by vertical (not used if $page = -1) 127 | * @throws OdfException 128 | * @return odf 129 | */ 130 | public function setImage($key, $value, $page = -1, $width = null, $height = null, $offsetX = null, $offsetY = null) 131 | { 132 | $filename = strtok(strrchr($value, '/'), '/.'); 133 | $file = substr(strrchr($value, '/'), 1); 134 | $size = @getimagesize($value); 135 | if ($size === false) { 136 | throw new OdfException("Invalid image"); 137 | } 138 | if (!$width && !$height) { 139 | list ($width, $height) = $size; 140 | $width *= Odf::PIXEL_TO_CM; 141 | $height *= Odf::PIXEL_TO_CM; 142 | } 143 | $anchor = $page == -1 ? 'text:anchor-type="as-char"' : "text:anchor-type=\"page\" text:anchor-page-number=\"{$page}\" svg:x=\"{$offsetX}cm\" svg:y=\"{$offsetY}cm\""; 144 | $xml = << 146 | IMG; 147 | 148 | $this->images[$value] = $file; 149 | $this->manif_vars[] = $file; //save image name as array element 150 | $this->setVars($key, $xml, false); 151 | return $this; 152 | } 153 | 154 | /** 155 | * Move segment tags for lines of tables 156 | * Called automatically within the constructor 157 | * 158 | * @return void 159 | */ 160 | private function _moveRowSegments() 161 | { 162 | // Search all possible rows in the document 163 | $reg1 = "#]*>(.*)#smU"; 164 | preg_match_all($reg1, $this->contentXml, $matches); 165 | for ($i = 0, $size = count($matches[0]); $i < $size; $i++) { 166 | // Check if the current row contains a segment row.* 167 | $reg2 = '#\[!--\sBEGIN\s(row.[\S]*)\s--\](.*)\[!--\sEND\s\\1\s--\]#smU'; 168 | if (preg_match($reg2, $matches[0][$i], $matches2)) { 169 | $balise = str_replace('row.', '', $matches2[1]); 170 | // Move segment tags around the row 171 | $replace = array( 172 | '[!-- BEGIN ' . $matches2[1] . ' --]' => '', 173 | '[!-- END ' . $matches2[1] . ' --]' => '', 174 | ' '[!-- BEGIN ' . $balise . ' --]' => '[!-- END ' . $balise . ' --]' 176 | ); 177 | $replacedXML = str_replace(array_keys($replace), array_values($replace), $matches[0][$i]); 178 | $this->contentXml = str_replace($matches[0][$i], $replacedXML, $this->contentXml); 179 | } 180 | } 181 | } 182 | 183 | /** 184 | * Merge template variables 185 | * Called automatically for a save 186 | * 187 | * @return void 188 | */ 189 | private function _parse() 190 | { 191 | $this->contentXml = str_replace(array_keys($this->vars), array_values($this->vars), $this->contentXml); 192 | $this->stylesXml = str_replace(array_keys($this->vars), array_values($this->vars), $this->stylesXml); 193 | } 194 | /** 195 | * Add the merged segment to the document 196 | * 197 | * @param Segment $segment 198 | * @throws OdfException 199 | * @return odf 200 | */ 201 | public function mergeSegment(Segment $segment) 202 | { 203 | if (! array_key_exists($segment->getName(), $this->segments)) { 204 | throw new OdfException($segment->getName() . 'cannot be parsed, has it been set yet ?'); 205 | } 206 | $string = $segment->getName(); 207 | // $reg = '@]*>\[!--\sBEGIN\s' . $string . '\s--\](.*)\[!--.+END\s' . $string . '\s--\]<\/text:p>@smU'; 208 | $reg = '@\[!--\sBEGIN\s' . $string . '\s--\](.*)\[!--.+END\s' . $string . '\s--\]@smU'; 209 | $this->contentXml = preg_replace($reg, $segment->getXmlParsed(), $this->contentXml); 210 | foreach ($segment->manif_vars as $val) { 211 | $this->manif_vars[] = $val; //copy all segment image names into current array 212 | } 213 | return $this; 214 | } 215 | 216 | /** 217 | * Display all the current template variables 218 | * 219 | * @return string 220 | */ 221 | public function printVars() 222 | { 223 | return print_r('
' . print_r($this->vars, true) . '
', true); 224 | } 225 | 226 | /** 227 | * Display the XML content of the file from odt document 228 | * as it is at the moment 229 | * 230 | * @return string 231 | */ 232 | public function __toString() 233 | { 234 | return $this->contentXml; 235 | } 236 | 237 | /** 238 | * Display loop segments declared with setSegment() 239 | * 240 | * @return string 241 | */ 242 | public function printDeclaredSegments() 243 | { 244 | return '
' . print_r(implode(' ', array_keys($this->segments)), true) . '
'; 245 | } 246 | 247 | /** 248 | * Declare a segment in order to use it in a loop 249 | * 250 | * @param string $segment 251 | * @throws OdfException 252 | * @return Segment 253 | */ 254 | public function setSegment($segment) 255 | { 256 | if (array_key_exists($segment, $this->segments)) { 257 | return $this->segments[$segment]; 258 | } 259 | // $reg = "#\[!--\sBEGIN\s$segment\s--\]<\/text:p>(.*?)\[!--\sEND\s$segment\s--\]#sm"; 260 | $reg = "#\[!--\sBEGIN\s$segment\s--\](.*?)\[!--\sEND\s$segment\s--\]#smU"; 261 | if (preg_match($reg, html_entity_decode($this->contentXml), $m) == 0) { 262 | throw new OdfException("'$segment' segment not found in the document"); 263 | } 264 | $this->segments[$segment] = new Segment($segment, $m[1], $this); 265 | return $this->segments[$segment]; 266 | } 267 | 268 | /** 269 | * Save the odt file on the disk 270 | * 271 | * @param string $file name of the desired file 272 | * @throws OdfException 273 | * @return void 274 | */ 275 | public function saveToDisk($file = null) 276 | { 277 | if ($file !== null && is_string($file)) { 278 | if (file_exists($file) && !(is_file($file) && is_writable($file))) { 279 | throw new OdfException('Permission denied : can\'t create ' . $file); 280 | } 281 | $this->_save(); 282 | copy($this->tmpfile, $file); 283 | } else { 284 | $this->_save(); 285 | } 286 | } 287 | 288 | /** 289 | * Internal save 290 | * 291 | * @throws OdfException 292 | * @return void 293 | */ 294 | private function _save() 295 | { 296 | $this->file->open($this->tmpfile); 297 | $this->_parse(); 298 | if (!$this->file->addFromString('content.xml', $this->contentXml) || !$this->file->addFromString('styles.xml', $this->stylesXml)) { 299 | throw new OdfException('Error during file export addFromString'); 300 | } 301 | $lastpos=strrpos($this->manifestXml, "\n", -15); //find second last newline in the manifest.xml file 302 | $manifdata = ""; 303 | 304 | //Enter all images description in $manifdata variable 305 | foreach ($this->manif_vars as $val) { 306 | $ext = substr(strrchr($val, '.'), 1); 307 | $manifdata = $manifdata.''."\n"; 308 | } 309 | //Place content of $manifdata variable in manifest.xml file at appropriate place 310 | $this->manifestXml = substr_replace($this->manifestXml, "\n".$manifdata, $lastpos+1, 0); 311 | //$this->manifestXml = $this->manifestXml ."\n".$manifdata; 312 | 313 | if (! $this->file->addFromString('META-INF/manifest.xml', $this->manifestXml)) { 314 | throw new OdfException('Error during manifest file export'); 315 | } 316 | foreach ($this->images as $imageKey => $imageValue) { 317 | $this->file->addFile($imageKey, 'Pictures/' . $imageValue); 318 | } 319 | $this->file->close(); // seems to bug on windows CLI sometimes 320 | } 321 | 322 | /** 323 | * Export the file as attached file by HTTP 324 | * 325 | * @param string $name (optionnal) 326 | * @throws OdfException 327 | * @return void 328 | */ 329 | public function exportAsAttachedFile($name = "") 330 | { 331 | $this->_save(); 332 | if (headers_sent($filename, $linenum)) { 333 | throw new OdfException("headers already sent ($filename at $linenum)"); 334 | } 335 | 336 | if ($name == "") { 337 | $name = md5(uniqid()) . ".odt"; 338 | } 339 | 340 | header('Content-type: application/vnd.oasis.opendocument.text'); 341 | header('Content-Disposition: attachment; filename="'.$name.'"'); 342 | readfile($this->tmpfile); 343 | } 344 | 345 | /** 346 | * Returns a variable of configuration 347 | * 348 | * @return string The requested variable of configuration 349 | */ 350 | public function getConfig($configKey) 351 | { 352 | if (array_key_exists($configKey, $this->config)) { 353 | return $this->config[$configKey]; 354 | } 355 | return false; 356 | } 357 | 358 | /** 359 | * Returns the temporary working file 360 | * 361 | * @return string le chemin vers le fichier temporaire de travail 362 | */ 363 | public function getTmpfile() 364 | { 365 | return $this->tmpfile; 366 | } 367 | 368 | 369 | /** 370 | * Recursive htmlspecialchars 371 | */ 372 | protected function recursiveHtmlspecialchars($value) 373 | { 374 | if (is_array($value)) { 375 | return array_map(array($this, 'recursiveHtmlspecialchars'), $value); 376 | } else { 377 | return htmlspecialchars($value); 378 | } 379 | } 380 | } 381 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------