unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob d8905d08e7c48131e4581e39e411a0079c24c263 3700 bytes (raw)
name: util/hex-escape.c 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
/* hex-escape.c -  Manage encoding and decoding of byte strings into path names
 *
 * Copyright (c) 2011 David Bremner
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see http://www.gnu.org/licenses/ .
 *
 * Author: David Bremner <david@tethera.net>
 */

#include <assert.h>
#include <string.h>
#include <talloc.h>
#include <ctype.h>
#include "error_util.h"
#include "hex-escape.h"

static const size_t default_buf_size = 1024;

static const char *output_charset =
    "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+-_@=.:,";

static const char escape_char = '%';

static int
is_output (char c)
{
    return (strchr (output_charset, c) != NULL);
}

static int
maybe_realloc (void *ctx, size_t needed, char **out, size_t *out_size)
{
    if (*out_size < needed) {

	if (*out == NULL)
	    *out = talloc_size (ctx, needed);
	else
	    *out = talloc_realloc (ctx, *out, char, needed);

	if (*out == NULL)
	    return 0;

	*out_size = needed;
    }
    return 1;
}

hex_status_t
hex_encode (void *ctx, const char *in, char **out, size_t *out_size)
{

    const unsigned char *p;
    char *q;

    size_t escape_count = 0;
    size_t len = 0;
    size_t needed;

    assert (ctx); assert (in); assert (out); assert (out_size);

    for (p = (unsigned char *) in; *p; p++) {
	escape_count += (!is_output (*p));
	len++;
    }

    needed = len + escape_count * 2 + 1;

    if (*out == NULL)
	*out_size = 0;

    if (!maybe_realloc (ctx, needed, out, out_size))
	return HEX_OUT_OF_MEMORY;

    q = *out;
    p = (unsigned char *) in;

    while (*p) {
	if (is_output (*p)) {
	    *q++ = *p++;
	} else {
	    sprintf (q, "%%%02x", *p++);
	    q += 3;
	}
    }

    *q = '\0';
    return HEX_SUCCESS;
}

/* Hex decode 'in' to 'out'.
 *
 * This must succeed for in == out to support hex_decode_inplace().
 */
static hex_status_t
hex_decode_internal (const char *in, unsigned char *out)
{
    char buf[3];

    while (*in) {
	if (*in == escape_char) {
	    char *endp;

	    /* This also handles unexpected end-of-string. */
	    if (!isxdigit ((unsigned char) in[1]) ||
		!isxdigit ((unsigned char) in[2]))
		return HEX_SYNTAX_ERROR;

	    buf[0] = in[1];
	    buf[1] = in[2];
	    buf[2] = '\0';

	    *out = strtoul (buf, &endp, 16);

	    if (endp != buf + 2)
		return HEX_SYNTAX_ERROR;

	    in += 3;
	    out++;
	} else {
	    *out++ = *in++;
	}
    }

    *out = '\0';

    return HEX_SUCCESS;
}

hex_status_t
hex_decode_inplace (char *s)
{
    /* A decoded string is never longer than the encoded one, so it is
     * safe to decode a string onto itself. */
    return hex_decode_internal (s, (unsigned char *) s);
}

hex_status_t
hex_decode (void *ctx, const char *in, char **out, size_t * out_size)
{
    const char *p;
    size_t escape_count = 0;
    size_t needed = 0;

    assert (ctx); assert (in); assert (out); assert (out_size);

    size_t len = strlen (in);

    for (p = in; *p; p++)
	escape_count += (*p == escape_char);

    needed = len - escape_count * 2 + 1;

    if (!maybe_realloc (ctx, needed, out, out_size))
	return HEX_OUT_OF_MEMORY;

    return hex_decode_internal (in, (unsigned char *) *out);
}

debug log:

solving d8905d0 ...
found d8905d0 in https://yhetil.org/notmuch/1344888831-4301-2-git-send-email-bremner@debian.org/ ||
	https://yhetil.org/notmuch/1353265498-3839-2-git-send-email-david@tethera.net/ ||
	https://yhetil.org/notmuch/921e481740d8c546c5f40a4f455a9f245cae005f.1334404979.git.jani@nikula.org/ ||
	https://yhetil.org/notmuch/1353792017-31459-2-git-send-email-david@tethera.net/ ||
	https://yhetil.org/notmuch/1345382314-5330-2-git-send-email-david@tethera.net/

applying [1/1] https://yhetil.org/notmuch/1344888831-4301-2-git-send-email-bremner@debian.org/
diff --git a/util/hex-escape.c b/util/hex-escape.c
new file mode 100644
index 0000000..d8905d0

Checking patch util/hex-escape.c...
Applied patch util/hex-escape.c cleanly.

skipping https://yhetil.org/notmuch/1353265498-3839-2-git-send-email-david@tethera.net/ for d8905d0
skipping https://yhetil.org/notmuch/921e481740d8c546c5f40a4f455a9f245cae005f.1334404979.git.jani@nikula.org/ for d8905d0
skipping https://yhetil.org/notmuch/1353792017-31459-2-git-send-email-david@tethera.net/ for d8905d0
skipping https://yhetil.org/notmuch/1345382314-5330-2-git-send-email-david@tethera.net/ for d8905d0
index at:
100644 d8905d08e7c48131e4581e39e411a0079c24c263	util/hex-escape.c

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).