aboutsummaryrefslogtreecommitdiff
path: root/src/com/wilko/jaim/responses/ConfigTocResponse.java
blob: dc724884fbd8ce5a8768bd5bbf30a1cf87bac908 (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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/*
 *   (C) 2002 Paul Wilkinson  wilko@users.sourceforge.net
 *
 *   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 2 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, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

/*
 * ConfigTocResponse.java
 * Created on 1, October 2002
 */
package com.wilko.jaim.responses;

import com.wilko.jaim.*;

import java.util.*;

/**
 * A ConfigTocResponse contains the config message received from
 * the toc server.
 * This response is handled by the JaimConnection class, but may also be used by client programs.
 * Once this event has been received, information returned from {@link JaimConnection#getGroups} is valid
 *
 * @author Brett Humphreys, Paul Wilkinson
 */
public class ConfigTocResponse extends TocResponse implements TocResponseHandler {

    /**
     * Value for mode that indicates PERMIT ALL mode
     */
    public static final int PERMIT_ALL = 1;
    /**
     * Value for mode that indicates DENY ALL mode
     */
    public static final int DENY_ALL = 2;
    /**
     * Value for mode that indicates PERMIT SOME mode
     */
    public static final int PERMIT_SOME = 3;
    /**
     * Value for mode that indicates DENY SOME mode
     */
    public static final int DENY_SOME = 4;
    public static String RESPONSE_TYPE = "CONFIG";
    /**
     * The Vector of Group objects
     */
    private final Vector buddyList = new Vector();
    /**
     * The HashMap of known buddies
     */
    private HashMap buddies;
    /**
     * The mode for this configuration
     */
    private int mode;

    /**
     * Returns an Enumeration of groups.  Each Entry is a {@link Group}
     * Each group then has an Enumeration of buddies within that group See {@link Group#enumerateBuddies}.
     *
     * @return list of Group elements or an empty list if none are found.
     */
    public Enumeration enumerateGroups() {
        return buddyList.elements();
    }

    /**
     * Returns a Collection of groups. Each element is a {@link Group)
     *
     * @return the groups
     */
    public Collection getGroups() {
        java.util.Collection result = new Vector(buddyList);
        return result;
    }


    /**
     * Get the response type of  this response.  This method is used by the response dispatcher within JaimConnection
     *
     * @return The response type
     */
    public String getResponseType() {
        return RESPONSE_TYPE;
    }

    /**
     * Parses the config string.
     */
    public TocResponse parseString(String message) {
        ConfigTocResponse tr = new ConfigTocResponse();
        tr.doParse(message);
        return (tr);
    }

    private void doParse(String message) {
        cmd = message;
        int colonIndex = message.indexOf(':');
        //throw away the first word.
        message = message.substring(colonIndex + 1);
        buddies = new HashMap();
        StringTokenizer tok = new StringTokenizer(message, "\n");
        String itemType;
        String itemValue;
        Group currentGroup = null;
        Buddy tmpBuddy;
        while (tok.hasMoreTokens()) {
            // Can't tokenize on both \n and space since there could be spaces
            // in the name, so parsing by hand.
            itemType = tok.nextToken();
            int firstSpace = itemType.indexOf(' ');
            itemValue = itemType.substring(firstSpace + 1);
            itemType = itemType.substring(0, firstSpace);

            char type = itemType.charAt(0);
            switch (type) {
                case 'g':
                    currentGroup = new Group(itemValue);
                    buddyList.add(currentGroup);
                    break;

                case 'b':

                    tmpBuddy = getBuddy(itemValue);
                    //this shouldn't happen, but:
                    if (currentGroup == null) {
                        currentGroup = new Group("<unknown>");
                        buddyList.add(currentGroup);
                    }
                    currentGroup.addBuddy(tmpBuddy);


                    break;

                case 'p':
                    tmpBuddy = getBuddy(itemValue);
                    tmpBuddy.setPermit(true);
                    break;

                case 'm':
                    setMode(Integer.valueOf(itemValue).intValue());
                    break;

                case 'd':

                    tmpBuddy = getBuddy(itemValue);
                    tmpBuddy.setDeny(true);
                    break;
            }
        }
    }

    /**
     * Return an existing Buddy with the specified name or return a new buddy if the name is not known
     * The buddy is added to the buddies hash if it is a new buddy
     *
     * @param buddyName The name of the buddy we are looking for
     * @return The buddy object
     */

    private Buddy getBuddy(String buddyName) {
        Buddy retBuddy = (Buddy) buddies.get(buddyName);
        if (retBuddy == null) {
            retBuddy = new Buddy(buddyName);
            buddies.put(buddyName, retBuddy);
        }
        return (retBuddy);
    }

    /**
     * Gets the mode for this configuration
     *
     * @return mode for the configuration
     */
    public int getMode() {
        return mode;
    }

    /**
     * Sets the mode for this configuration
     *
     * @param modeVal the string value of the mode (1-4)
     */
    public void setMode(int modeVal) {
        mode = modeVal;
    }

    /**
     * Returns true if this response handler can handle the specified response.
     *
     * @param Response - the response string from TOC.  This is the part of the response before the first ':'
     * @return true if the response can be handled
     */
    public boolean canHandle(String Response) {
        return (Response.equalsIgnoreCase(RESPONSE_TYPE));
    }

}