/src/libzip/lib/zip_string.c

Source
/*
  zip_string.c -- string handling (with encoding)
  Copyright (C) 2012-2025 Dieter Baron and Thomas Klausner

  This file is part of libzip, a library to manipulate ZIP archives.
  The authors can be contacted at <info@libzip.org>

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions
  are met:
  1. Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in
     the documentation and/or other materials provided with the
     distribution.
  3. The names of the authors may not be used to endorse or promote
     products derived from this software without specific prior
     written permission.

  THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/


#include "zipint.h"

#include <stdlib.h>
#include <string.h>
#include <zlib.h>

zip_uint32_t _zip_string_crc32(const zip_string_t *s) {
    zip_uint32_t crc;

    crc = (zip_uint32_t)crc32(0L, Z_NULL, 0);

    if (s != NULL) {
        crc = (zip_uint32_t)crc32(crc, s->raw, s->length);
    }

    return crc;
}


int _zip_string_equal(const zip_string_t *a, const zip_string_t *b) {
    if (a == NULL || b == NULL) {
        return a == b;
    }

    if (a->length != b->length) {
        return 0;
    }

    /* TODO: encoding */

    return (memcmp(a->raw, b->raw, a->length) == 0);
}


void _zip_string_free(zip_string_t *s) {
    if (s == NULL) {
        return;
    }

    free(s->raw);
    free(s->converted);
    free(s);
}


const zip_uint8_t *_zip_string_get(zip_string_t *string, zip_uint32_t *lenp, zip_flags_t flags, zip_error_t *error) {
    static const zip_uint8_t empty[1] = "";

    if (string == NULL) {
        if (lenp) {
            *lenp = 0;
        }
        return empty;
    }

    if ((flags & ZIP_FL_ENC_RAW) == 0) {
        /* start guessing */
        if (string->encoding == ZIP_ENCODING_UNKNOWN) {
            /* guess encoding, sets string->encoding */
            (void)_zip_guess_encoding(string, ZIP_ENCODING_UNKNOWN);
        }

        if (((flags & ZIP_FL_ENC_STRICT) && string->encoding != ZIP_ENCODING_ASCII && string->encoding != ZIP_ENCODING_UTF8_KNOWN) || (string->encoding == ZIP_ENCODING_CP437)) {
            if (string->converted == NULL) {
                if ((string->converted = _zip_cp437_to_utf8(string->raw, string->length, &string->converted_length, error)) == NULL) {
                    return NULL;
                }
            }
            if (lenp) {
                *lenp = string->converted_length;
            }
            return string->converted;
        }
    }

    if (lenp) {
        *lenp = string->length;
    }
    return string->raw;
}

bool _zip_string_is_ascii(const zip_string_t *string) {
    if (string->encoding != ZIP_ENCODING_ASCII) {
        zip_uint16_t i;

        for (i = 0; i < string->length; i++) {
            if (string->raw[i] & 0x80) {
                return false;
            }
        }
    }

    return true;
}


zip_uint16_t _zip_string_length(const zip_string_t *s) {
    if (s == NULL) {
        return 0;
    }

    return s->length;
}


zip_string_t *_zip_string_new(const zip_uint8_t *raw, zip_uint16_t length, zip_flags_t flags, zip_error_t *error) {
    zip_string_t *s;
    zip_encoding_type_t expected_encoding;

    if (length == 0) {
        return NULL;
    }

    switch (flags & ZIP_FL_ENCODING_ALL) {
    case ZIP_FL_ENC_GUESS:
        expected_encoding = ZIP_ENCODING_UNKNOWN;
        break;
    case ZIP_FL_ENC_UTF_8:
        expected_encoding = ZIP_ENCODING_UTF8_KNOWN;
        break;
    case ZIP_FL_ENC_CP437:
        expected_encoding = ZIP_ENCODING_CP437;
        break;
    default:
        zip_error_set(error, ZIP_ER_INVAL, 0);
        return NULL;
    }

    if ((s = (zip_string_t *)malloc(sizeof(*s))) == NULL) {
        zip_error_set(error, ZIP_ER_MEMORY, 0);
        return NULL;
    }

    if ((s->raw = (zip_uint8_t *)malloc((size_t)length + 1)) == NULL) {
        zip_error_set(error, ZIP_ER_MEMORY, 0);
        free(s);
        return NULL;
    }

    (void)memcpy_s(s->raw, length + 1, raw, length);
    s->raw[length] = '\0';
    s->length = length;
    s->encoding = ZIP_ENCODING_UNKNOWN;
    s->converted = NULL;
    s->converted_length = 0;

    if (expected_encoding != ZIP_ENCODING_UNKNOWN) {
        if (_zip_guess_encoding(s, expected_encoding) == ZIP_ENCODING_ERROR) {
            _zip_string_free(s);
            zip_error_set(error, ZIP_ER_INVAL, 0);
            return NULL;
        }
    }

    return s;
}


int _zip_string_write(zip_t *za, const zip_string_t *s) {
    if (s == NULL) {
        return 0;
    }

    return _zip_write(za, s->raw, s->length);
}

Line	Count	Source
1		/*
2		zip_string.c -- string handling (with encoding)
3		Copyright (C) 2012-2025 Dieter Baron and Thomas Klausner
4
5		This file is part of libzip, a library to manipulate ZIP archives.
6		The authors can be contacted at <info@libzip.org>
7
8		Redistribution and use in source and binary forms, with or without
9		modification, are permitted provided that the following conditions
10		are met:
11		1. Redistributions of source code must retain the above copyright
12		notice, this list of conditions and the following disclaimer.
13		2. Redistributions in binary form must reproduce the above copyright
14		notice, this list of conditions and the following disclaimer in
15		the documentation and/or other materials provided with the
16		distribution.
17		3. The names of the authors may not be used to endorse or promote
18		products derived from this software without specific prior
19		written permission.
20
21		THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
22		OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23		WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24		ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
25		DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26		DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
27		GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28		INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
29		IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30		OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
31		IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32		*/
33
34
35		#include "zipint.h"
36
37		#include <stdlib.h>
38		#include <string.h>
39		#include <zlib.h>
40
41	42	zip_uint32_t _zip_string_crc32(const zip_string_t *s) {
42	42	zip_uint32_t crc;
43
44	42	crc = (zip_uint32_t)crc32(0L, Z_NULL, 0);
45
46	42	if (s != NULL) {
47	31	crc = (zip_uint32_t)crc32(crc, s->raw, s->length);
48	31	}
49
50	42	return crc;
51	42	}
52
53
54	0	int _zip_string_equal(const zip_string_t a, const zip_string_t b) {
55	0	if (a == NULL \|\| b == NULL) {
56	0	return a == b;
57	0	}
58
59	0	if (a->length != b->length) {
60	0	return 0;
61	0	}
62
63		/* TODO: encoding */
64
65	0	return (memcmp(a->raw, b->raw, a->length) == 0);
66	0	}
67
68
69	167k	void _zip_string_free(zip_string_t *s) {
70	167k	if (s == NULL) {
71	99.5k	return;
72	99.5k	}
73
74	68.0k	free(s->raw);
75	68.0k	free(s->converted);
76	68.0k	free(s);
77	68.0k	}
78
79
80	83.4k	const zip_uint8_t _zip_string_get(zip_string_t string, zip_uint32_t lenp, zip_flags_t flags, zip_error_t error) {
81	83.4k	static const zip_uint8_t empty[1] = "";
82
83	83.4k	if (string == NULL) {
84	132	if (lenp) {
85	0	*lenp = 0;
86	0	}
87	132	return empty;
88	132	}
89
90	83.3k	if ((flags & ZIP_FL_ENC_RAW) == 0) {
91		/* start guessing */
92	83.3k	if (string->encoding == ZIP_ENCODING_UNKNOWN) {
93		/* guess encoding, sets string->encoding */
94	37.5k	(void)_zip_guess_encoding(string, ZIP_ENCODING_UNKNOWN);
95	37.5k	}
96
97	83.3k	if (((flags & ZIP_FL_ENC_STRICT) && string->encoding != ZIP_ENCODING_ASCII && string->encoding != ZIP_ENCODING_UTF8_KNOWN) \|\| (string->encoding == ZIP_ENCODING_CP437)) {
98	215	if (string->converted == NULL) {
99	215	if ((string->converted = _zip_cp437_to_utf8(string->raw, string->length, &string->converted_length, error)) == NULL) {
100	0	return NULL;
101	0	}
102	215	}
103	215	if (lenp) {
104	0	*lenp = string->converted_length;
105	0	}
106	215	return string->converted;
107	215	}
108	83.3k	}
109
110	83.1k	if (lenp) {
111	0	*lenp = string->length;
112	0	}
113	83.1k	return string->raw;
114	83.3k	}
115
116	0	bool _zip_string_is_ascii(const zip_string_t *string) {
117	0	if (string->encoding != ZIP_ENCODING_ASCII) {
118	0	zip_uint16_t i;
119
120	0	for (i = 0; i < string->length; i++) {
121	0	if (string->raw[i] & 0x80) {
122	0	return false;
123	0	}
124	0	}
125	0	}
126
127	0	return true;
128	0	}
129
130
131	4.63k	zip_uint16_t _zip_string_length(const zip_string_t *s) {
132	4.63k	if (s == NULL) {
133	3.78k	return 0;
134	3.78k	}
135
136	852	return s->length;
137	4.63k	}
138
139
140	68.0k	zip_string_t _zip_string_new(const zip_uint8_t raw, zip_uint16_t length, zip_flags_t flags, zip_error_t *error) {
141	68.0k	zip_string_t *s;
142	68.0k	zip_encoding_type_t expected_encoding;
143
144	68.0k	if (length == 0) {
145	0	return NULL;
146	0	}
147
148	68.0k	switch (flags & ZIP_FL_ENCODING_ALL) {
149	68.0k	case ZIP_FL_ENC_GUESS:
150	68.0k	expected_encoding = ZIP_ENCODING_UNKNOWN;
151	68.0k	break;
152	5	case ZIP_FL_ENC_UTF_8:
153	5	expected_encoding = ZIP_ENCODING_UTF8_KNOWN;
154	5	break;
155	0	case ZIP_FL_ENC_CP437:
156	0	expected_encoding = ZIP_ENCODING_CP437;
157	0	break;
158	0	default:
159	0	zip_error_set(error, ZIP_ER_INVAL, 0);
160	0	return NULL;
161	68.0k	}
162
163	68.0k	if ((s = (zip_string_t )malloc(sizeof(s))) == NULL) {
164	0	zip_error_set(error, ZIP_ER_MEMORY, 0);
165	0	return NULL;
166	0	}
167
168	68.0k	if ((s->raw = (zip_uint8_t *)malloc((size_t)length + 1)) == NULL) {
169	0	zip_error_set(error, ZIP_ER_MEMORY, 0);
170	0	free(s);
171	0	return NULL;
172	0	}
173
174	68.0k	(void)memcpy_s(s->raw, length + 1, raw, length);
175	68.0k	s->raw[length] = '\0';
176	68.0k	s->length = length;
177	68.0k	s->encoding = ZIP_ENCODING_UNKNOWN;
178	68.0k	s->converted = NULL;
179	68.0k	s->converted_length = 0;
180
181	68.0k	if (expected_encoding != ZIP_ENCODING_UNKNOWN) {
182	5	if (_zip_guess_encoding(s, expected_encoding) == ZIP_ENCODING_ERROR) {
183	4	_zip_string_free(s);
184	4	zip_error_set(error, ZIP_ER_INVAL, 0);
185	4	return NULL;
186	4	}
187	5	}
188
189	68.0k	return s;
190	68.0k	}
191
192
193	0	int _zip_string_write(zip_t za, const zip_string_t s) {
194	0	if (s == NULL) {
195	0	return 0;
196	0	}
197
198	0	return _zip_write(za, s->raw, s->length);
199	0	}

Coverage Report

Created: 2026-10-14 06:52