1 /* ====================================================================
2  * The Kannel Software License, Version 1.0
3  *
4  * Copyright (c) 2001-2014 Kannel Group
5  * Copyright (c) 1998-2001 WapIT Ltd.
6  * All rights reserved.
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  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  *    if any, must include the following acknowledgment:
22  *       "This product includes software developed by the
23  *        Kannel Group (http://www.kannel.org/)."
24  *    Alternately, this acknowledgment may appear in the software itself,
25  *    if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Kannel" and "Kannel Group" must not be used to
28  *    endorse or promote products derived from this software without
29  *    prior written permission. For written permission, please
30  *    contact org@kannel.org.
31  *
32  * 5. Products derived from this software may not be called "Kannel",
33  *    nor may "Kannel" appear in their name, without prior written
34  *    permission of the Kannel Group.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED.  IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS
40  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
41  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
42  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
43  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
44  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
45  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
46  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Kannel Group.  For more information on
51  * the Kannel Group, please see <http://www.kannel.org/>.
52  *
53  * Portions of this software are based upon software originally written at
54  * WapIT Ltd., Helsinki, Finland for the Kannel project.
55  */
56 
57 /*
58  * wap_push_pap_compiler.h - compiling PAP control document to a Kannel event.
59  *
60  * By Aarno Syv�nen for Wapit Ltd.
61  */
62 
63 #ifndef WAP_PUSH_PAP_COMPILER_H
64 #define WAP_PUSH_PAP_COMPILER_H
65 
66 #include "wap/wap_events.h"
67 #include "gwlib/gwlib.h"
68 
69 /*
70  * Possible address types
71  */
72 enum {
73     ADDR_IPV4 = 0,
74     ADDR_PLMN = 1,
75     ADDR_USER = 2,
76     ADDR_IPV6 = 3,
77     ADDR_WINA = 4
78 };
79 
80 /*
81  *Compile PAP control document to a corresponding Kannel event. Checks vali-
82  * dity of the document. The caller must initialize wap event to NULL. In add-
83  * ition, it must free memory allocated by this function.
84  *
85  * After compiling, some semantic analysing of the resulted event.
86  *
87  * Note that entities in the DTD are parameter entities and they can appear
88  * only in DTD (See site http://www.w3.org/TR/REC-xml, Chapter 4.1). So we do
89  * not need to worry about them in the document itself.
90  *
91  * Returns 0, when success
92  *        -1, when a non-implemented pap feature is asked for
93  *        -2, when error
94  * In addition, returns a newly created wap event corresponding the pap
95  * control message, if success, wap event NULL otherwise.
96  */
97 int pap_compile(Octstr *pap_content, WAPEvent **e);
98 
99 int parse_address(Octstr **attr_value, long *type_of_address);
100 
101 #endif
102 
103