2014-05-05 10:30:43 -07:00
|
|
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
2012-05-21 04:12:37 -07:00
|
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
/* First checked in on 98/12/03 by John R. McMullen, derived from net.h/mkparse.c. */
|
|
|
|
|
|
|
|
#ifndef _ESCAPE_H_
|
|
|
|
#define _ESCAPE_H_
|
|
|
|
|
|
|
|
#include "nscore.h"
|
|
|
|
#include "nsError.h"
|
|
|
|
#include "nsString.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Valid mask values for nsEscape
|
|
|
|
* Note: these values are copied in nsINetUtil.idl. Any changes should be kept
|
|
|
|
* in sync.
|
|
|
|
*/
|
|
|
|
typedef enum {
|
2014-05-14 13:15:46 -07:00
|
|
|
url_All = 0, // %-escape every byte unconditionally
|
|
|
|
url_XAlphas = 1u << 0, // Normal escape - leave alphas intact, escape the rest
|
|
|
|
url_XPAlphas = 1u << 1, // As url_XAlphas, but convert spaces (0x20) to '+' and plus to %2B
|
|
|
|
url_Path = 1u << 2 // As url_XAlphas, but don't escape slash ('/')
|
2007-03-22 10:30:00 -07:00
|
|
|
} nsEscapeMask;
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Escape the given string according to mask
|
|
|
|
* @param str The string to escape
|
|
|
|
* @param mask How to escape the string
|
|
|
|
* @return A newly allocated escaped string that must be free'd with
|
|
|
|
* nsCRT::free, or null on failure
|
|
|
|
*/
|
2014-05-14 13:15:46 -07:00
|
|
|
char* nsEscape(const char* aStr, nsEscapeMask aMask);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2014-05-14 13:15:46 -07:00
|
|
|
char* nsUnescape(char* aStr);
|
2014-05-05 10:30:43 -07:00
|
|
|
/* decode % escaped hex codes into character values,
|
|
|
|
* modifies the parameter, returns the same buffer
|
|
|
|
*/
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2014-05-14 13:15:46 -07:00
|
|
|
int32_t nsUnescapeCount(char* aStr);
|
2014-05-05 10:30:43 -07:00
|
|
|
/* decode % escaped hex codes into character values,
|
|
|
|
* modifies the parameter buffer, returns the length of the result
|
|
|
|
* (result may contain \0's).
|
|
|
|
*/
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2014-05-14 13:15:46 -07:00
|
|
|
char*
|
|
|
|
nsEscapeHTML(const char* aString);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2014-05-14 13:15:46 -07:00
|
|
|
char16_t*
|
|
|
|
nsEscapeHTML2(const char16_t* aSourceBuffer,
|
2012-08-22 08:56:38 -07:00
|
|
|
int32_t aSourceBufferLen = -1);
|
2014-05-05 10:30:43 -07:00
|
|
|
/*
|
|
|
|
* Escape problem char's for HTML display
|
|
|
|
*/
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* NS_EscapeURL/NS_UnescapeURL constants for |flags| parameter:
|
2007-06-21 13:18:25 -07:00
|
|
|
*
|
|
|
|
* Note: These values are copied to nsINetUtil.idl
|
|
|
|
* Any changes should be kept in sync
|
2007-03-22 10:30:00 -07:00
|
|
|
*/
|
|
|
|
enum EscapeMask {
|
|
|
|
/** url components **/
|
2012-10-19 19:01:43 -07:00
|
|
|
esc_Scheme = 1u << 0,
|
|
|
|
esc_Username = 1u << 1,
|
|
|
|
esc_Password = 1u << 2,
|
|
|
|
esc_Host = 1u << 3,
|
|
|
|
esc_Directory = 1u << 4,
|
|
|
|
esc_FileBaseName = 1u << 5,
|
|
|
|
esc_FileExtension = 1u << 6,
|
2007-03-22 10:30:00 -07:00
|
|
|
esc_FilePath = esc_Directory | esc_FileBaseName | esc_FileExtension,
|
2012-10-19 19:01:43 -07:00
|
|
|
esc_Param = 1u << 7,
|
|
|
|
esc_Query = 1u << 8,
|
|
|
|
esc_Ref = 1u << 9,
|
2007-03-22 10:30:00 -07:00
|
|
|
/** special flags **/
|
2014-05-05 10:30:43 -07:00
|
|
|
esc_Minimal = esc_Scheme | esc_Username | esc_Password | esc_Host | esc_FilePath | esc_Param | esc_Query | esc_Ref,
|
2012-10-19 19:01:43 -07:00
|
|
|
esc_Forced = 1u << 10, /* forces escaping of existing escape sequences */
|
|
|
|
esc_OnlyASCII = 1u << 11, /* causes non-ascii octets to be skipped */
|
2014-05-05 10:30:43 -07:00
|
|
|
esc_OnlyNonASCII = 1u << 12, /* causes _graphic_ ascii octets (0x20-0x7E)
|
2007-03-22 10:30:00 -07:00
|
|
|
* to be skipped when escaping. causes all
|
2007-08-31 13:19:37 -07:00
|
|
|
* ascii octets (<= 0x7F) to be skipped when unescaping */
|
2012-10-19 19:01:43 -07:00
|
|
|
esc_AlwaysCopy = 1u << 13, /* copy input to result buf even if escaping is unnecessary */
|
|
|
|
esc_Colon = 1u << 14, /* forces escape of colon */
|
|
|
|
esc_SkipControl = 1u << 15 /* skips C0 and DEL from unescaping */
|
2007-03-22 10:30:00 -07:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* NS_EscapeURL
|
|
|
|
*
|
|
|
|
* Escapes invalid char's in an URL segment. Has no side-effect if the URL
|
|
|
|
* segment is already escaped. Otherwise, the escaped URL segment is appended
|
|
|
|
* to |result|.
|
|
|
|
*
|
|
|
|
* @param str url segment string
|
|
|
|
* @param len url segment string length (-1 if unknown)
|
|
|
|
* @param flags url segment type flag
|
|
|
|
* @param result result buffer, untouched if part is already escaped
|
|
|
|
*
|
|
|
|
* @return TRUE if escaping was performed, FALSE otherwise.
|
|
|
|
*/
|
2014-05-14 13:15:46 -07:00
|
|
|
bool NS_EscapeURL(const char* aStr,
|
|
|
|
int32_t aLen,
|
|
|
|
uint32_t aFlags,
|
|
|
|
nsACString& aResult);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Expands URL escape sequences... beware embedded null bytes!
|
|
|
|
*
|
|
|
|
* @param str url string to unescape
|
|
|
|
* @param len length of |str|
|
2014-05-05 10:30:43 -07:00
|
|
|
* @param flags only esc_OnlyNonASCII, esc_SkipControl and esc_AlwaysCopy
|
2007-03-22 10:30:00 -07:00
|
|
|
* are recognized
|
|
|
|
* @param result result buffer, untouched if |str| is already unescaped
|
|
|
|
*
|
|
|
|
* @return TRUE if unescaping was performed, FALSE otherwise.
|
|
|
|
*/
|
2014-05-14 13:15:46 -07:00
|
|
|
bool NS_UnescapeURL(const char* aStr,
|
|
|
|
int32_t aLen,
|
|
|
|
uint32_t aFlags,
|
|
|
|
nsACString& aResult);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
/** returns resultant string length **/
|
2014-05-14 13:15:46 -07:00
|
|
|
inline int32_t
|
|
|
|
NS_UnescapeURL(char* aStr)
|
|
|
|
{
|
|
|
|
return nsUnescapeCount(aStr);
|
2007-03-22 10:30:00 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* String friendly versions...
|
|
|
|
*/
|
2014-05-14 13:15:46 -07:00
|
|
|
inline const nsCSubstring&
|
|
|
|
NS_EscapeURL(const nsCSubstring& aStr, uint32_t aFlags, nsCSubstring& aResult)
|
|
|
|
{
|
|
|
|
if (NS_EscapeURL(aStr.Data(), aStr.Length(), aFlags, aResult)) {
|
|
|
|
return aResult;
|
|
|
|
}
|
|
|
|
return aStr;
|
2007-03-22 10:30:00 -07:00
|
|
|
}
|
2014-05-14 13:15:46 -07:00
|
|
|
inline const nsCSubstring&
|
|
|
|
NS_UnescapeURL(const nsCSubstring& aStr, uint32_t aFlags, nsCSubstring& aResult)
|
|
|
|
{
|
|
|
|
if (NS_UnescapeURL(aStr.Data(), aStr.Length(), aFlags, aResult)) {
|
|
|
|
return aResult;
|
|
|
|
}
|
|
|
|
return aStr;
|
2007-03-22 10:30:00 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* CString version of nsEscape. Returns true on success, false
|
|
|
|
* on out of memory. To reverse this function, use NS_UnescapeURL.
|
|
|
|
*/
|
2011-09-28 23:19:26 -07:00
|
|
|
inline bool
|
2007-03-22 10:30:00 -07:00
|
|
|
NS_Escape(const nsCString& aOriginal, nsCString& aEscaped,
|
|
|
|
nsEscapeMask aMask)
|
|
|
|
{
|
|
|
|
char* esc = nsEscape(aOriginal.get(), aMask);
|
2014-05-14 13:15:46 -07:00
|
|
|
if (! esc) {
|
2011-10-17 07:59:28 -07:00
|
|
|
return false;
|
2014-05-14 13:15:46 -07:00
|
|
|
}
|
2007-03-22 10:30:00 -07:00
|
|
|
aEscaped.Adopt(esc);
|
2011-10-17 07:59:28 -07:00
|
|
|
return true;
|
2007-03-22 10:30:00 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Inline unescape of mutable string object.
|
|
|
|
*/
|
2014-05-14 13:15:46 -07:00
|
|
|
inline nsCString&
|
|
|
|
NS_UnescapeURL(nsCString& aStr)
|
2007-03-22 10:30:00 -07:00
|
|
|
{
|
2014-05-14 13:15:46 -07:00
|
|
|
aStr.SetLength(nsUnescapeCount(aStr.BeginWriting()));
|
|
|
|
return aStr;
|
2007-03-22 10:30:00 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
#endif // _ESCAPE_H_
|