Annotation of parser3/src/include/pa_string.h, revision 1.98
1.41 paf 1: /** @file
1.43 paf 2: Parser: string class decl.
3:
1.29 paf 4: Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
1.43 paf 5:
1.30 paf 6: Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
1.29 paf 7:
1.98 ! parser 8: $Id: pa_string.h,v 1.97 2001/07/07 17:59:02 parser Exp $
1.1 paf 9: */
10:
11: #ifndef PA_STRING_H
12: #define PA_STRING_H
13:
1.49 paf 14: #include "pa_config_includes.h"
1.15 paf 15: #include "pa_pool.h"
1.4 paf 16: #include "pa_types.h"
17:
1.63 paf 18: class Table;
19:
1.50 paf 20: /**
1.92 parser 21: $MAIN:html-typo table elements must enlarge string not more that that.
22:
1.50 paf 23: that's a tradeoff - otherwise we'd have to scan string twice:
24: - first for buffer length
25: - second for replacements themselves
26: */
1.92 parser 27: #define UNTAINT_TIMES_BIGGER 10
1.31 paf 28:
1.9 paf 29: #ifndef NO_STRING_ORIGIN
1.33 paf 30: # define STRING_APPEND_PARAMS \
31: const char *src, size_t size, \
1.52 paf 32: String::Untaint_lang lang, \
1.33 paf 33: const char *file, uint line
1.54 paf 34: /// appends piece to String @see String::real_append
35: # define APPEND(src, size, lang, file, line) \
36: real_append(src, size, lang, file, line)
1.9 paf 37: #else
1.33 paf 38: # define STRING_APPEND_PARAMS \
39: const char *src, \
40: size_t size, \
1.52 paf 41: String::Untaint_lang lang
1.54 paf 42: /// appends piece to String @see String::real_append
43: # define APPEND(src, size, lang, file, line) \
44: real_append(src, size, lang)
45: #endif
1.83 paf 46: /// appends clean piece to String @see String::real_append
1.54 paf 47: #define APPEND_CLEAN(src, size, file, line) \
1.62 paf 48: APPEND(src, size, String::UL_CLEAN, file, line)
1.83 paf 49: /// appends piece to String as-is @see String::real_append
50: #define APPEND_AS_IS(src, size, file, line) \
51: APPEND(src, size, String::UL_AS_IS, file, line)
1.48 paf 52: /// appends tainted piece to String @see String::real_append
1.54 paf 53: #define APPEND_TAINTED(src, size, file, line) \
1.62 paf 54: APPEND(src, size, String::UL_TAINTED, file, line)
1.48 paf 55: /// handy: appends const char* piece to String @see String::real_append
1.83 paf 56: #define APPEND_CONST(src) APPEND_AS_IS(src, 0, 0, 0)
1.9 paf 57:
1.62 paf 58: class Array;
1.71 paf 59: class SQL_Connection;
1.62 paf 60:
1.42 paf 61: /**
1.41 paf 62: Pooled string.
63:
1.47 paf 64: Internal structure:
65: @verbatim
66: String Chunk0
67: ====== ========
68: head--------------->[ptr, size, ...]
69: append_here-------->[ptr, size, ...]
70: .
71: .
72: [ptr, size, ...]
73: link_row----------->[link to the next chunk]
1.41 paf 74: @endverbatim
75:
76: All pieces remember
77: - the file and its line they are from [can be turned off by NO_STRING_ORIGIN]
78: - whether they are tainted or not,
79: and the language which should be used to detaint them
80: */
1.15 paf 81: class String : public Pooled {
1.1 paf 82: public:
1.48 paf 83:
1.1 paf 84: enum {
1.89 parser 85: CR_PREALLOCATED_COUNT=2, ///< default preallocated item count
1.91 parser 86: CR_GROW_COUNT=2 ///< each time the String chunk_is_full() string expanded()
1.1 paf 87: };
88:
1.41 paf 89: /// piece is tainted or not. the language to use when detaint
1.27 paf 90: enum Untaint_lang {
1.72 paf 91: UL_UNSPECIFIED=0, ///< zero value handy for hash lookup @see untaint_lang_name2enum
1.62 paf 92: UL_CLEAN, ///< clean
93: UL_TAINTED, ///< tainted, untaint language as assigned later
1.27 paf 94: // untaint languages. assigned by ^untaint[lang]{...}
1.48 paf 95: UL_PASS_APPENDED,
1.41 paf 96: /**<
97: leave language built into string being appended.
98: just a flag, that value not stored
99: */
1.48 paf 100: UL_AS_IS, ///< leave all characters intact
101: UL_FILE_NAME, ///< filename
1.74 paf 102: UL_HTTP_HEADER, ///< text in HTTP response header
103: UL_MAIL_HEADER, ///< text in mail header
1.48 paf 104: UL_URI, ///< text in uri
105: UL_TABLE, ///< ^table:set body
106: UL_SQL, ///< ^table:sql body
107: UL_JS, ///< JavaScript code
108: UL_HTML, ///< HTML code (for editing)
1.85 paf 109: UL_USER_HTML ///< HTML code with USER chars
1.27 paf 110: };
111:
1.8 paf 112: public:
113:
1.77 paf 114: String(Pool& apool, const char *src=0, size_t src_size=0, bool tainted=false);
1.14 paf 115: String(const String& src);
116: size_t size() const { return fsize; }
1.98 ! parser 117: /// makes store_to produce origin:text\n output
! 118: void set_origins_mode(bool aorigins_mode) const { forigins_mode=aorigins_mode; }
1.69 paf 119: /// convert to C string. if 'lang' known, forcing 'lang' to it
1.82 paf 120: char *cstr(Untaint_lang lang=UL_UNSPECIFIED,
121: SQL_Connection *connection=0,
122: const char *charset=0) const {
1.88 parser 123:
1.94 parser 124: char *result=(char *)malloc(cstr_bufsize(lang));
1.82 paf 125: char *eol=store_to(result, lang, connection, charset);
1.50 paf 126: *eol=0;
127: return result;
128: }
1.46 paf 129: /** append fragment
1.83 paf 130: @see APPEND_AS_IS, APPEND_CLEAN, APPEND_TAINTED, APPEND_CONST
1.46 paf 131: */
1.9 paf 132: String& real_append(STRING_APPEND_PARAMS);
1.44 paf 133: /// @return <0 ==0 or >0 depending on comparison result
1.62 paf 134: int cmp (int& partial, const String& src,
1.72 paf 135: size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.56 paf 136: bool operator < (const String& src) const { int p; return cmp(p, src)<0; }
137: bool operator > (const String& src) const { int p; return cmp(p, src)>0; }
138: bool operator <= (const String& src) const { int p; return cmp(p, src)<=0; }
139: bool operator >= (const String& src) const { int p; return cmp(p, src)>=0; }
1.26 paf 140: bool operator == (const String& src) const {
141: if(size()!=src.size()) // can speed up in trivial case
142: return false;
1.56 paf 143: int p; return cmp(p, src)==0;
1.26 paf 144: }
1.56 paf 145: bool operator != (const String& src) const { int p; return cmp(p, src)!=0; }
1.26 paf 146:
1.50 paf 147: /**
148: @param partial
149: returns partial match status.
1.51 paf 150: - -1: strings too different
151: - 0: full match
152: - 1: means @c this starts @c src
153: - 2: means @src starts @this
1.50 paf 154: */
1.61 paf 155: int cmp(int& partial, const char* src_ptr, size_t src_size=0,
1.72 paf 156: size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.50 paf 157: bool operator == (const char* src_ptr) const {
158: size_t src_size=src_ptr?strlen(src_ptr):0;
159: if(size() != src_size)
160: return false;
161: int partial; // unused
1.56 paf 162: return cmp(partial, src_ptr, src_size)==0;
1.50 paf 163: }
1.80 paf 164: bool operator != (const char* src_ptr) const {
165: int partial; // unused
166: return cmp(partial, src_ptr, 0)!=0;
167: }
168:
1.50 paf 169:
1.42 paf 170: /**
171: appends other String.
1.41 paf 172:
1.47 paf 173: marking all tainted pieces of it with @a lang.
174: or marking ALL pieces of it with a @a lang when @a forced to.
1.41 paf 175: */
1.39 paf 176: String& append(const String& src, Untaint_lang lang, bool forced=false);
1.76 paf 177: String& operator << (const String& src) { return append(src, UL_PASS_APPENDED); }
178: String& operator << (const char *src) { return APPEND_CONST(src); }
1.8 paf 179:
1.41 paf 180: /// simple hash code of string. used by Hash
1.14 paf 181: uint hash_code() const;
1.54 paf 182:
183: /// extracts [start, finish) piece of string
1.70 paf 184: String& mid(size_t start, size_t finish) const;
1.55 paf 185:
1.59 paf 186: /// @return position of substr in string, -1 means "not found" [String version]
1.62 paf 187: int pos(const String& substr,
1.72 paf 188: size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.59 paf 189: /// @return position of substr in string, -1 means "not found" [const char* version]
1.97 parser 190: int pos(const char *substr, size_t substr_size=0,
1.72 paf 191: size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.62 paf 192:
193: void split(Array& result,
194: size_t *pos_after_ref,
195: const char *delim, size_t delim_size,
1.86 paf 196: Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;
1.62 paf 197: void split(Array& result,
198: size_t *pos_after_ref,
199: const String& delim,
1.86 paf 200: Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;
1.62 paf 201:
1.68 paf 202: typedef void (*Row_action)(Table& table, Array *row, int start, int finish,
203: void *info);
1.87 parser 204: /**
205: @return true if fills table.
206: table format is defined and fixed[can be used by others]:
207: @verbatim
208: prematch/match/postmatch/1/2/3/...
209: @endverbatim
210: */
1.81 paf 211: bool match(const unsigned char *pcre_tables,
212: const String *aorigin,
1.64 paf 213: const String& regexp,
1.65 paf 214: const String *options,
1.66 paf 215: Table **table,
216: Row_action row_action, void *info) const;
1.87 parser 217: enum Change_case_kind {
218: CC_UPPER,
219: CC_LOWER
220: };
221: String& change_case(Pool& pool, const unsigned char *pcre_tables,
222: Change_case_kind kind) const;
1.96 parser 223: double as_double() const;
224: int as_int() const;
1.13 paf 225:
1.41 paf 226: #ifndef NO_STRING_ORIGIN
227: /// origin of string. calculated by first row
1.43 paf 228: const Origin& origin() const;
1.41 paf 229: #endif
1.8 paf 230:
1.10 paf 231: private:
232:
1.84 paf 233: /// several String fragments
1.1 paf 234: struct Chunk {
1.84 paf 235: size_t count; ///< the number of rows in chunk
236: /// string fragment or a link to next chunk union
1.1 paf 237: union Row {
1.84 paf 238: /// fragment
1.27 paf 239: struct {
1.84 paf 240: const char *ptr; ///< pointer to the start
241: size_t size; ///< length
242: Untaint_lang lang; ///< untaint flag, later untaint language
1.27 paf 243: #ifndef NO_STRING_ORIGIN
1.84 paf 244: Origin origin; ///< origin
1.27 paf 245: #endif
1.1 paf 246: } item;
1.84 paf 247: Chunk *link; ///< link to the next chunk in chain
1.2 paf 248: } rows[CR_PREALLOCATED_COUNT];
1.84 paf 249: Chunk *preallocated_link; ///< next rows are here
1.1 paf 250: }
1.84 paf 251: head; ///< the head chunk of the chunk chain
1.1 paf 252:
1.84 paf 253: /// next append would write to this record
1.1 paf 254: Chunk::Row *append_here;
255:
1.84 paf 256: /** the address of place where lies address
257: of the link to the next chunk to allocate
258: */
1.1 paf 259: Chunk::Row *link_row;
260:
1.5 paf 261: private:
1.25 paf 262: // last chunk
263: Chunk *last_chunk;
1.5 paf 264:
265: // string size
266: size_t fsize;
267:
268: // used rows in all chunks
269: int fused_rows;
1.98 ! parser 270:
! 271: /// origins_mode changes behaviour of store_to[cstr()]
! 272: mutable bool forigins_mode;
1.5 paf 273:
274: private:
1.1 paf 275:
276: bool chunk_is_full() {
277: return append_here == link_row;
278: }
279: void expand();
1.79 paf 280:
1.94 parser 281: size_t cstr_bufsize(Untaint_lang lang) const;
1.79 paf 282: /// convert to C string, store to 'dest' which must be big enough for proper untaint
1.82 paf 283: char *store_to(char *dest, Untaint_lang lang=UL_UNSPECIFIED,
284: SQL_Connection *connection=0,
285: const char *charset=0) const;
1.7 paf 286:
287: private: //disabled
288:
1.12 paf 289: String& operator = (const String&) { return *this; }
1.7 paf 290:
1.1 paf 291: };
292:
293: #endif
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to pa_string.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / include