Merge commit 'catalyst/MOODLE_19_STABLE' into mdl19-linuxchix

[moodle-linuxchix.git] / lib / pclzip / readme.txt

// --------------------------------------------------------------------------------\r
// PclZip 2.5 - readme.txt\r
// --------------------------------------------------------------------------------\r
// License GNU/LGPL - March 2006\r
// Vincent Blavet - vincent@phpconcept.net\r
// http://www.phpconcept.net\r
// --------------------------------------------------------------------------------\r
// $Id$\r
// --------------------------------------------------------------------------------\r
\r
\r
\r
0 - Sommaire\r
============\r
    1 - Introduction\r
    2 - What's new\r
    3 - Corrected bugs\r
    4 - Known bugs or limitations\r
    5 - License\r
    6 - Warning\r
    7 - Documentation\r
    8 - Author\r
    9 - Contribute\r
\r
1 - Introduction\r
================\r
\r
  PclZip is a library that allow you to manage a Zip archive.\r
\r
  Full documentation about PclZip can be found here : http://www.phpconcept.net/pclzip\r
\r
2 - What's new\r
==============\r
\r
  Version 2.5 :\r
    - Introduce the ability to add file/folder with individual properties (file descriptor).\r
      This gives for example the ability to change the filename of a zipped file.\r
      . Able to add files individually\r
      . Able to change full name\r
      . Able to change short name\r
      . Compatible with global options\r
    - New attributes : PCLZIP_ATT_FILE_NAME, PCLZIP_ATT_FILE_NEW_SHORT_NAME, PCLZIP_ATT_FILE_NEW_FULL_NAME\r
    - New error code : PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE\r
    - Add a security control feature. PclZip can extract any file in any folder\r
      of a system. People may use this to upload a zip file and try to override\r
      a system file. The PCLZIP_OPT_EXTRACT_DIR_RESTRICTION will give the\r
      ability to forgive any directory transversal behavior.\r
    - New PCLZIP_OPT_EXTRACT_DIR_RESTRICTION : check extraction path\r
    - New error code : PCLZIP_ERR_DIRECTORY_RESTRICTION\r
    - Modification in PclZipUtilPathInclusion() : dir and path beginning with ./ will be prepend\r
      by current path (getcwd())\r
  \r
  Version 2.4 :\r
    - Code improvment : try to speed up the code by removing unusefull call to pack()\r
    - Correct bug in delete() : delete() should be called with no argument. This was not\r
      the case in 2.3. This is corrected in 2.4.\r
    - Correct a bug in path_inclusion function. When the path has several '../../', the\r
      result was bad.\r
    - Add a check for magic_quotes_runtime configuration. If enabled, PclZip will \r
      disable it while working and det it back to its original value.\r
      This resolve a lots of bad formated archive errors.\r
    - Bug correction : PclZip now correctly unzip file in some specific situation,\r
      when compressed content has same size as uncompressed content.\r
    - Bug correction : When selecting option 'PCLZIP_OPT_REMOVE_ALL_PATH', \r
      directories are not any more created.\r
    - Code improvment : correct unclosed opendir(), better handling of . and .. in\r
      loops.\r
\r
\r
  Version 2.3 :\r
    - Correct a bug with PHP5 : affecting the value 0xFE49FFE0 to a variable does not\r
      give the same result in PHP4 and PHP5 ....\r
\r
  Version 2.2 :\r
    - Try development of PCLZIP_OPT_CRYPT .....\r
      However this becomes to a stop. To crypt/decrypt I need to multiply 2 long integers,\r
      the result (greater than a long) is not supported by PHP. Even the use of bcmath\r
      functions does not help. I did not find yet a solution ...;\r
    - Add missing '/' at end of directory entries\r
    - Check is a file is encrypted or not. Returns status 'unsupported_encryption' and/or\r
      error code PCLZIP_ERR_UNSUPPORTED_ENCRYPTION.\r
    - Corrected : Bad "version need to extract" field in local file header\r
    - Add private method privCheckFileHeaders() in order to check local and central\r
      file headers. PclZip is now supporting purpose bit flag bit 3. Purpose bit flag bit 3 gives\r
      the ability to have a local file header without size, compressed size and crc filled.\r
    - Add a generic status 'error' for file status\r
    - Add control of compression type. PclZip only support deflate compression method.\r
      Before v2.2, PclZip does not check the compression method used in an archive while\r
      extracting. With v2.2 PclZip returns a new error status for a file using an unsupported\r
      compression method. New status is "unsupported_compression". New error code is\r
      PCLZIP_ERR_UNSUPPORTED_COMPRESSION.\r
    - Add optional attribute PCLZIP_OPT_STOP_ON_ERROR. This will stop the extract of files\r
      when errors like 'a folder with same name exists' or 'a newer file exists' or\r
      'a write protected file' exists, rather than set a status for the concerning file\r
      and resume the extract of the zip.\r
    - Add optional attribute PCLZIP_OPT_REPLACE_NEWER. This will force, during an extract' the\r
      replacement of the file, even if a  newer version of the file exists.\r
      Note that today if a file with the same name already exists but is older it will be\r
      replaced by the extracted one.\r
    - Improve PclZipUtilOption()\r
    - Support of zip archive with trailing bytes. Before 2.2, PclZip checks that the central\r
      directory structure is the last data in the archive. Crypt encryption/decryption of\r
      zip archive put trailing 0 bytes after decryption. PclZip is now supporting this.\r
\r
  Version 2.1 :\r
    - Add the ability to abort the extraction by using a user callback function.\r
      The user can now return the value '2' in its callback which indicates to stop the\r
      extraction. For a pre call-back extract is stopped before the extration of the current\r
      file. For a post call back, the extraction is stopped after.\r
    - Add the ability to extract a file (or several files) directly in the standard output.\r
      This is done by the new parameter PCLZIP_OPT_EXTRACT_IN_OUTPUT with method extract().\r
    - Add support for parameters PCLZIP_OPT_COMMENT, PCLZIP_OPT_ADD_COMMENT,\r
      PCLZIP_OPT_PREPEND_COMMENT. This will create, replace, add, or prepend comments\r
      in the zip archive.\r
    - When merging two archives, the comments are not any more lost, but merged, with a \r
      blank space separator.\r
    - Corrected bug : Files are not deleted when all files are asked to be deleted.\r
    - Corrected bug : Folders with name '0' made PclZip to abort the create or add feature.\r
\r
\r
  Version 2.0 :\r
    ***** Warning : Some new features may break the backward compatibility for your scripts.\r
                    Please carefully read the readme file.\r
    - Add the ability to delete by Index, name and regular expression. This feature is \r
      performed by the method delete(), which uses the optional parameters\r
      PCLZIP_OPT_BY_INDEX, PCLZIP_OPT_BY_NAME, PCLZIP_OPT_BY_EREG or PCLZIP_OPT_BY_PREG.\r
    - Add the ability to extract by regular expression. To extract by regexp you must use the method\r
      extract(), with the option PCLZIP_OPT_BY_EREG or PCLZIP_OPT_BY_PREG \r
      (depending if you want to use ereg() or preg_match() syntax) followed by the \r
      regular expression pattern.\r
    - Add the ability to extract by index, directly with the extract() method. This is a\r
      code improvment of the extractByIndex() method.\r
    - Add the ability to extract by name. To extract by name you must use the method\r
      extract(), with the option PCLZIP_OPT_BY_NAME followed by the filename to\r
      extract or an array of filenames to extract. To extract all a folder, use the folder\r
      name rather than the filename with a '/' at the end.\r
    - Add the ability to add files without compression. This is done with a new attribute\r
      which is PCLZIP_OPT_NO_COMPRESSION.\r
    - Add the attribute PCLZIP_OPT_EXTRACT_AS_STRING, which allow to extract a file directly\r
      in a string without using any file (or temporary file).\r
    - Add constant PCLZIP_SEPARATOR for static configuration of filename separators in a single string.\r
      The default separator is now a comma (,) and not any more a blank space.\r
      THIS BREAK THE BACKWARD COMPATIBILITY : Please check if this may have an impact with\r
      your script.\r
    - Improve algorythm performance by removing the use of temporary files when adding or \r
      extracting files in an archive.\r
    - Add (correct) detection of empty filename zipping. This can occurs when the removed\r
      path is the same\r
      as a zipped dir. The dir is not zipped (['status'] = filtered), only its content.\r
    - Add better support for windows paths (thanks for help from manus@manusfreedom.com).\r
    - Corrected bug : When the archive file already exists with size=0, the add() method\r
      fails. Corrected in 2.0.\r
    - Remove the use of OS_WINDOWS constant. Use php_uname() function rather.\r
    - Control the order of index ranges in extract by index feature.\r
    - Change the internal management of folders (better handling of internal flag).\r
\r
\r
  Version 1.3 :\r
    - Removing the double include check. This is now done by include_once() and require_once()\r
      PHP directives.\r
    - Changing the error handling mecanism : Remove the use of an external error library.\r
      The former PclError...() functions are replaced by internal equivalent methods.\r
      By changing the environment variable PCLZIP_ERROR_EXTERNAL you can still use the former library.\r
      Introducing the use of constants for error codes rather than integer values. This will help\r
      in futur improvment.\r
      Introduction of error handling functions like errorCode(), errorName() and errorInfo().\r
    - Remove the deprecated use of calling function with arguments passed by reference.\r
    - Add the calling of extract(), extractByIndex(), create() and add() functions\r
      with variable options rather than fixed arguments.\r
    - Add the ability to remove all the file path while extracting or adding,\r
      without any need to specify the path to remove.\r
      This is available for extract(), extractByIndex(), create() and add() functionS by using\r
      the new variable options parameters :\r
      - PCLZIP_OPT_REMOVE_ALL_PATH : by indicating this option while calling the fct.\r
    - Ability to change the mode of a file after the extraction (chmod()).\r
      This is available for extract() and extractByIndex() functionS by using\r
      the new variable options parameters.\r
      - PCLZIP_OPT_SET_CHMOD : by setting the value of this option.\r
    - Ability to definition call-back options. These call-back will be called during the adding,\r
      or the extracting of file (extract(), extractByIndex(), create() and add() functions) :\r
      - PCLZIP_CB_PRE_EXTRACT : will be called before each extraction of a file. The user\r
        can trigerred the change the filename of the extracted file. The user can triggered the\r
        skip of the extraction. This is adding a 'skipped' status in the file list result value.\r
      - PCLZIP_CB_POST_EXTRACT : will be called after each extraction of a file.\r
        Nothing can be triggered from that point.\r
      - PCLZIP_CB_PRE_ADD : will be called before each add of a file. The user\r
        can trigerred the change the stored filename of the added file. The user can triggered the\r
        skip of the add. This is adding a 'skipped' status in the file list result value.\r
      - PCLZIP_CB_POST_ADD : will be called after each add of a file.\r
        Nothing can be triggered from that point.\r
    - Two status are added in the file list returned as function result : skipped & filename_too_long\r
      'skipped' is used when a call-back function ask for skipping the file.\r
      'filename_too_long' is used while adding a file with a too long filename to archive (the file is\r
      not added)\r
    - Adding the function PclZipUtilPathInclusion(), that check the inclusion of a path into\r
      a directory.\r
    - Add a check of the presence of the archive file before some actions (like list, ...)\r
    - Add the initialisation of field "index" in header array. This means that by\r
      default index will be -1 when not explicitly set by the methods.\r
\r
  Version 1.2 :\r
    - Adding a duplicate function.\r
    - Adding a merge function. The merge function is a "quick merge" function,\r
      it just append the content of an archive at the end of the first one. There\r
      is no check for duplicate files or more recent files.\r
    - Improve the search of the central directory end.\r
\r
  Version 1.1.2 :\r
\r
    - Changing the license of PclZip. PclZip is now released under the GNU / LGPL license\r
      (see License section).\r
    - Adding the optional support of a static temporary directory. You will need to configure\r
      the constant PCLZIP_TEMPORARY_DIR if you want to use this feature.\r
    - Improving the rename() function. In some cases rename() does not work (different\r
      Filesystems), so it will be replaced by a copy() + unlink() functions.\r
\r
  Version 1.1.1 :\r
\r
    - Maintenance release, no new feature.\r
\r
  Version 1.1 :\r
\r
    - New method Add() : adding files in the archive\r
    - New method ExtractByIndex() : partial extract of the archive, files are identified by\r
      their index in the archive\r
    - New method DeleteByIndex() : delete some files/folder entries from the archive,\r
      files are identified by their index in the archive.\r
    - Adding a test of the zlib extension presence. If not present abort the script.\r
\r
  Version 1.0.1 :\r
\r
    - No new feature\r
\r
\r
3 - Corrected bugs\r
==================\r
\r
  Corrected in Version 2.0 :\r
    - Corrected : During an extraction, if a call-back fucntion is used and try to skip\r
                  a file, all the extraction process is stopped. \r
\r
  Corrected in Version 1.3 :\r
    - Corrected : Support of static synopsis for method extract() is broken.\r
    - Corrected : invalid size of archive content field (0xFF) should be (0xFFFF).\r
    - Corrected : When an extract is done with a remove_path parameter, the entry for\r
      the directory with exactly the same path is not skipped/filtered.\r
    - Corrected : extractByIndex() and deleteByIndex() were not managing index in the\r
      right way. For example indexes '1,3-5,11' will only extract files 1 and 11. This\r
      is due to a sort of the index resulting table that puts 11 before 3-5 (sort on\r
      string and not interger). The sort is temporarilly removed, this means that\r
      you must provide a sorted list of index ranges.\r
\r
  Corrected in Version 1.2 :\r
\r
    - Nothing.\r
\r
  Corrected in Version 1.1.2 :\r
\r
    - Corrected : Winzip is unable to delete or add new files in a PclZip created archives.\r
\r
  Corrected in Version 1.1.1 :\r
\r
    - Corrected : When archived file is not compressed (0% compression), the\r
      extract method fails.\r
\r
  Corrected in Version 1.1 :\r
\r
    - Corrected : Adding a complete tree of folder may result in a bad archive\r
      creation.\r
\r
  Corrected in Version 1.0.1 :\r
\r
    - Corrected : Error while compressing files greater than PCLZIP_READ_BLOCK_SIZE (default=1024).\r
\r
\r
4 - Known bugs or limitations\r
=============================\r
\r
  Please publish bugs reports in SourceForge :\r
    http://sourceforge.net/tracker/?group_id=40254&atid=427564\r
\r
  In Version 2.x :\r
    - PclZip does only support file uncompressed or compressed with deflate (compression method 8)\r
    - PclZip does not support password protected zip archive\r
\r
  In Version 1.2 :\r
\r
    - merge() methods does not check for duplicate files or last date of modifications.\r
\r
  In Version 1.1 :\r
\r
    - Limitation : Using 'extract' fields in the file header in the zip archive is not supported.\r
    - WinZip is unable to delete a single file in a PclZip created archive. It is also unable to\r
      add a file in a PclZip created archive. (Corrected in v.1.2)\r
\r
  In Version 1.0.1 :\r
\r
    - Adding a complete tree of folder may result in a bad archive\r
      creation. (Corrected in V.1.1).\r
    - Path given to methods must be in the unix format (/) and not the Windows format (\).\r
      Workaround : Use only / directory separators.\r
    - PclZip is using temporary files that are sometime the name of the file with a .tmp or .gz\r
      added suffix. Files with these names may already exist and may be overwritten.\r
      Workaround : none.\r
    - PclZip does not check if the zlib extension is present. If it is absent, the zip\r
      file is not created and the lib abort without warning.\r
      Workaround : enable the zlib extension on the php install\r
\r
  In Version 1.0 :\r
\r
    - Error while compressing files greater than PCLZIP_READ_BLOCK_SIZE (default=1024).\r
      (Corrected in v.1.0.1)\r
    - Limitation : Multi-disk zip archive are not supported.\r
\r
\r
5 - License\r
===========\r
\r
  Since version 1.1.2, PclZip Library is released under GNU/LGPL license.\r
  This library is free, so you can use it at no cost.\r
\r
  HOWEVER, if you release a script, an application, a library or any kind of\r
  code using PclZip library (or a part of it), YOU MUST :\r
  - Indicate in the documentation (or a readme file), that your work\r
    uses PclZip Library, and make a reference to the author and the web site\r
    http://www.phpconcept.net\r
  - Gives the ability to the final user to update the PclZip libary.\r
\r
  I will also appreciate that you send me a mail (vincent@phpconcept.net), just to\r
  be aware that someone is using PclZip.\r
\r
  For more information about GNU/LGPL license : http://www.gnu.org\r
\r
6 - Warning\r
=================\r
\r
  This library and the associated files are non commercial, non professional work.\r
  It should not have unexpected results. However if any damage is caused by this software\r
  the author can not be responsible.\r
  The use of this software is at the risk of the user.\r
\r
7 - Documentation\r
=================\r
  PclZip User Manuel is available in English on PhpConcept : http://www.phpconcept.net/pclzip/man/en/index.php\r
  A Russian translation was done by Feskov Kuzma : http://php.russofile.ru/ru/authors/unsort/zip/\r
\r
8 - Author\r
==========\r
\r
  This software was written by Vincent Blavet (vincent@phpconcept.net) on its leasure time.\r
\r
9 - Contribute\r
==============\r
  If you want to contribute to the development of PclZip, please contact vincent@phpconcept.net.\r
  If you can help in financing PhpConcept hosting service, please go to\r
  http://www.phpconcept.net/soutien.php\r