mbspatch.h 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. /*-
  2. * Copyright 2003,2004 Colin Percival
  3. * All rights reserved
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted providing that the following conditions
  7. * are met:
  8. * 1. Redistributions of source code must retain the above copyright
  9. * notice, this list of conditions and the following disclaimer.
  10. * 2. Redistributions in binary form must reproduce the above copyright
  11. * notice, this list of conditions and the following disclaimer in the
  12. * documentation and/or other materials provided with the distribution.
  13. *
  14. * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15. * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  18. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  22. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  23. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24. * POSSIBILITY OF SUCH DAMAGE.
  25. *
  26. * Changelog:
  27. * 2005-04-26 - Define the header as a C structure, add a CRC32 checksum to
  28. * the header, and make all the types 32-bit.
  29. * --Benjamin Smedberg <benjamin@smedbergs.us>
  30. */
  31. #ifndef bspatch_h__
  32. #define bspatch_h__
  33. #define OK 0
  34. #define MEM_ERROR 1
  35. // #define IO_ERROR 2 // Use READ_ERROR or WRITE_ERROR instead
  36. #define USAGE_ERROR 3
  37. #define CRC_ERROR 4
  38. #define PARSE_ERROR 5
  39. #define READ_ERROR 6
  40. #define WRITE_ERROR 7
  41. #define UNEXPECTED_ERROR 8
  42. typedef struct MBSPatchHeader_ {
  43. /* "MBDIFF10" */
  44. char tag[8];
  45. /* Length of the file to be patched */
  46. unsigned int slen;
  47. /* CRC32 of the file to be patched */
  48. unsigned int scrc32;
  49. /* Length of the result file */
  50. unsigned int dlen;
  51. /* Length of the control block in bytes */
  52. unsigned int cblen;
  53. /* Length of the diff block in bytes */
  54. unsigned int difflen;
  55. /* Length of the extra block in bytes */
  56. unsigned int extralen;
  57. /* Control block (MBSPatchTriple[]) */
  58. /* Diff block (binary data) */
  59. /* Extra block (binary data) */
  60. } MBSPatchHeader;
  61. /**
  62. * Read the header of a patch file into the MBSPatchHeader structure.
  63. *
  64. * @param fd Must have been opened for reading, and be at the beginning
  65. * of the file.
  66. */
  67. int MBS_ReadHeader(int fd, MBSPatchHeader *header);
  68. /**
  69. * Apply a patch. This method does not validate the checksum of the original
  70. * file: client code should validate the checksum before calling this method.
  71. *
  72. * @param patchfd Must have been processed by MBS_ReadHeader
  73. * @param fbuffer The original file read into a memory buffer of length
  74. * header->slen.
  75. * @param filefd Must have been opened for writing. Should be truncated
  76. * to header->dlen if it is an existing file. The offset
  77. * should be at the beginning of the file.
  78. */
  79. int MBS_ApplyPatch(const MBSPatchHeader *header, int patchfd,
  80. unsigned char *fbuffer, int filefd);
  81. typedef struct MBSPatchTriple_ {
  82. unsigned int x; /* add x bytes from oldfile to x bytes from the diff block */
  83. unsigned int y; /* copy y bytes from the extra block */
  84. int z; /* seek forwards in oldfile by z bytes */
  85. } MBSPatchTriple;
  86. /**
  87. * Apply the given patch file to a given source file. This method validates
  88. * the CRC of the original file stored in the patch file, before applying the
  89. * patch to it.
  90. */
  91. int ApplyBinaryPatch(const wchar_t *old_file, const wchar_t *patch_file,
  92. const wchar_t *new_file);
  93. /**
  94. * Calculates Crc of the given buffer by calling CRC method in LZMA SDK
  95. */
  96. int CalculateCrc(const unsigned char *buf, int size);
  97. #endif // bspatch_h__