From 8196af9fc4f2eb0cb0a3d5a8522508533caa2c09 Mon Sep 17 00:00:00 2001 From: Jani Nikula Date: Sun, 1 Apr 2012 01:17:21 +0300 Subject: [PATCH] [PATCH 1/8] hex-escape: (en|de)code strings to/from restricted character set --- a2/cf77736c898f9499c770c79c637a95b2ed400e | 297 ++++++++++++++++++++++ 1 file changed, 297 insertions(+) create mode 100644 a2/cf77736c898f9499c770c79c637a95b2ed400e diff --git a/a2/cf77736c898f9499c770c79c637a95b2ed400e b/a2/cf77736c898f9499c770c79c637a95b2ed400e new file mode 100644 index 000000000..23acba56b --- /dev/null +++ b/a2/cf77736c898f9499c770c79c637a95b2ed400e @@ -0,0 +1,297 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id DC6FF42116A + for ; Sat, 31 Mar 2012 15:17:45 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References" +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id pKSerVo0XCdY for ; + Sat, 31 Mar 2012 15:17:43 -0700 (PDT) +Received: from mail-bk0-f53.google.com (mail-bk0-f53.google.com + [209.85.214.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 468C2429E54 + for ; Sat, 31 Mar 2012 15:17:39 -0700 (PDT) +Received: by mail-bk0-f53.google.com with SMTP id j4so1547751bkw.26 + for ; Sat, 31 Mar 2012 15:17:39 -0700 (PDT) +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=google.com; s=20120113; + h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references + :in-reply-to:references:x-gm-message-state; + bh=Hz2+KZxj5Kpv8YFLNT74TEGUMY0ki3yMWdw2jyYy7aU=; + b=KzcnRddeJBeD62HBrsoLh9zZixtJAmB1Uk5GBxtGJ7jCeMUYgmqnc4y7hH6qAS2Gzj + Lxny33RgWS4uMGZBN+7ZZ9qqz33YtFgcQM2CSitkzbNxfYsNqzoXFXDqiBNLlt7yrNqm + lzI6v6FChp/6gXv1UudfiHJ5rgImMaSl49TQ7JsmsOaD6FYxes/sQVrO669whrW2jTst + ZVcEBlDmfceWn6Vlrjvhw5o2zD2RUMGabF7BXHXe7OML8GPlHbCRlE972PXsbFVUSqQY + gGW1WbiSDQ7tdUzrxVgciSZq98DzS9IMmFSyVwjwyNbvtS5mxisKypgElurBw3B+Qdgr + z34A== +Received: by 10.204.153.203 with SMTP id l11mr1400223bkw.31.1333232258791; + Sat, 31 Mar 2012 15:17:38 -0700 (PDT) +Received: from localhost (dsl-hkibrasgw4-fe50f800-253.dhcp.inet.fi. + [84.248.80.253]) + by mx.google.com with ESMTPS id f5sm28556643bke.9.2012.03.31.15.17.34 + (version=SSLv3 cipher=OTHER); Sat, 31 Mar 2012 15:17:37 -0700 (PDT) +From: Jani Nikula +To: notmuch@notmuchmail.org +Subject: [PATCH 1/8] hex-escape: (en|de)code strings to/from restricted + character set +Date: Sun, 1 Apr 2012 01:17:21 +0300 +Message-Id: + <3431e1b916320f0ab19b412ad877955f446de443.1333231401.git.jani@nikula.org> +X-Mailer: git-send-email 1.7.5.4 +In-Reply-To: +References: +In-Reply-To: +References: +X-Gm-Message-State: + ALoCoQnbqd8opq8R24U6UJWITmt05o206ubzmI8cfcwPxP3i70dnH8Nra6FC1uoMdrKiaG+Zc97Q +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sat, 31 Mar 2012 22:17:46 -0000 + +From: David Bremner + +The character set is chosen to be suitable for pathnames, and the same +as that used by contrib/nmbug +--- + util/Makefile.local | 2 +- + util/hex-escape.c | 156 +++++++++++++++++++++++++++++++++++++++++++++++++++ + util/hex-escape.h | 32 +++++++++++ + 3 files changed, 189 insertions(+), 1 deletions(-) + create mode 100644 util/hex-escape.c + create mode 100644 util/hex-escape.h + +diff --git a/util/Makefile.local b/util/Makefile.local +index c7cae61..3ca623e 100644 +--- a/util/Makefile.local ++++ b/util/Makefile.local +@@ -3,7 +3,7 @@ + dir := util + extra_cflags += -I$(srcdir)/$(dir) + +-libutil_c_srcs := $(dir)/xutil.c $(dir)/error_util.c ++libutil_c_srcs := $(dir)/xutil.c $(dir)/error_util.c $(dir)/hex-escape.c + + libutil_modules := $(libutil_c_srcs:.c=.o) + +diff --git a/util/hex-escape.c b/util/hex-escape.c +new file mode 100644 +index 0000000..6c1260b +--- /dev/null ++++ b/util/hex-escape.c +@@ -0,0 +1,156 @@ ++/* 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 ++ */ ++ ++#include ++#include ++#include ++#include "error_util.h" ++#include "hex-escape.h" ++ ++static const size_t default_buf_size = 1024; ++ ++static const char *output_charset = ++ "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+-_@=.:,"; ++ ++static const int 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_status_t ++hex_decode (void *ctx, const char *in, char **out, size_t * out_size) ++{ ++ ++ char buf[3]; ++ ++ const char *p; ++ unsigned char *q; ++ ++ 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; ++ ++ p = in; ++ q = (unsigned char *) *out; ++ buf[2] = 0; ++ ++ while (*p) { ++ ++ if (*p == escape_char) { ++ ++ char *endp; ++ ++ if (len < 3) ++ return HEX_SYNTAX_ERROR; ++ ++ buf[0] = p[1]; ++ buf[1] = p[2]; ++ ++ *q = strtol (buf, &endp, 16); ++ ++ if (endp != buf + 2) ++ return HEX_SYNTAX_ERROR; ++ ++ len -= 3; ++ p += 3; ++ q++; ++ } else { ++ *q++ = *p++; ++ } ++ } ++ ++ *q = '\0'; ++ ++ return HEX_SUCCESS; ++} +diff --git a/util/hex-escape.h b/util/hex-escape.h +new file mode 100644 +index 0000000..e409626 +--- /dev/null ++++ b/util/hex-escape.h +@@ -0,0 +1,32 @@ ++#ifndef _HEX_ESCAPE_H ++#define _HEX_ESCAPE_H ++ ++typedef enum hex_status { ++ HEX_SUCCESS = 0, ++ HEX_SYNTAX_ERROR, ++ HEX_OUT_OF_MEMORY ++} hex_status_t; ++ ++/* ++ * The API is modelled on that for getline. ++ * ++ * If 'out' points to a NULL pointer a char array of the appropriate ++ * size is allocated using talloc, and out_size is updated. ++ * ++ * If 'out' points to a non-NULL pointer, it assumed to describe an ++ * existing char array, with the size given in *out_size. This array ++ * may be resized by talloc_realloc if needed; in this case *out_size ++ * will also be updated. ++ * ++ * Note that it is an error to pass a NULL pointer for any parameter ++ * of these routines. ++ */ ++ ++hex_status_t ++hex_encode (void *talloc_ctx, const char *in, char **out, ++ size_t *out_size); ++ ++hex_status_t ++hex_decode (void *talloc_ctx, const char *in, char **out, ++ size_t *out_size); ++#endif +-- +1.7.5.4 + -- 2.26.2