summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/pattern/Pattern.java
blob: fe6426306637b02604ccea2e82b2440c11f4803a (plain)
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
// --- BEGIN COPYRIGHT BLOCK ---
// 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; version 2 of the License.
//
// 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, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.pattern;


import java.util.*;
import com.netscape.certsrv.base.*;


/**
 * This is a generic pattern subtitution engine. The
 * pattern format should be:
 * <p>
 *   $[attribute set key].[attribute name]$
 * <p>
 * For example,
 * <p>
 *   $request.requestor_email$
 *   $ctx.user_id$
 * <p>
 *
 * @version $Revision$, $Date$
 */
public class Pattern {

    private String mS = null;
   
    /**
     * Constructs a pattern object with the given string.
     *
     * @param s string with pattern (i.e. $request.requestor_email$)
     */
    public Pattern(String s) {
        mS = s;
    }

    /**
     * Subtitutes this pattern with the given attribute set.
     *
     * @param key key name of the given attribute set
     * @param attrSet attribute set
     * @return substituted string
     */
    public String substitute(String key, IAttrSet attrSet) {
        return substitute2(key, attrSet);
    }

    /**
     * Subtitutes this pattern with the given attribute set.
     *
     * @param attrSetCollection attribute set collection
     * @return substituted string
     */
    public String substitute(AttrSetCollection attrSetCollection) {
        String temp = mS;
        Enumeration keys = attrSetCollection.keys();

        while (keys.hasMoreElements()) {
            String key = (String) keys.nextElement();
            Pattern p = new Pattern(temp);

            temp = p.substitute(key, 
                        attrSetCollection.getAttrSet(key));
			
        }
        return temp;
    }

    /**
     * Subtitutes this pattern with the given attribute set.
     *
	 * This is an extended version of the substitute() method.
	 * It takes a more flexible pattern format that could have
	 * non-token ($...$) format.  e.g.
	 *    $request.screenname$@redhat.com
	 * where "@redhat.com" is not in token pattern format, and will be
	 * literally put in place. e.g.
	 *    TomRiddle@redhat.com
	 *
     * @param key key name of the given attribute set
     * @param attrSet attribute set
     * @return substituted string
     */
    public String substitute2(String key, IAttrSet attrSet) {
        StringBuffer sb = new StringBuffer();

        int startPos = 0;
        int lastPos;

        do {
			// from startPos to right before '$' or end of string
			// need to be copied over
			
            lastPos = mS.indexOf('$', startPos);

			// if no '$', return the entire string
            if (lastPos == -1 && startPos == 0)
              return mS;

			// no more '$' found, copy the rest of chars, done
            if (lastPos == -1) {
				sb.append(mS.substring(startPos)); //
				return sb.toString(); //
				//                continue;
			}

			// found '$'
            if (startPos < lastPos) {
                sb.append(mS.substring(startPos, lastPos));	
            }

			// look for the ending '$'
            int endPos = mS.indexOf('$', lastPos + 1);
            String token = mS.substring(lastPos + 1, endPos);
            int dotPos = token.indexOf('.');

			// it's assuming there's always a '.'
            String attrKey = token.substring(0, dotPos);
            String attrName = token.substring(dotPos + 1);

            if (!key.equals(attrKey)) {
                startPos = endPos + 1;
                sb.append("$" + attrKey + "." + attrName + "$");	
                continue;
            }

            try {
                Object o = attrSet.get(attrName);

                if (!(o instanceof String)) {
                    startPos = endPos + 1;	
					// if no such attrName, copy the token pattern over
                    sb.append("$" + attrKey + "." + attrName + "$");	
                    continue;
                }
                String val = (String) o;

                sb.append(val);	
            } catch (EBaseException e) {
                sb.append("$" + attrKey + "." + attrName + "$");	
            }
            startPos = endPos + 1;	
        }
        while (lastPos != -1);

        return sb.toString();
    }

}