CreateMUCRoom.java 6.13 KB
Newer Older
1
/*
2 3
 * Copyright (C) 2004-2008 Jive Software. All rights reserved.
 *
4 5 6 7 8 9 10 11 12 13 14
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
Alex Wenckus's avatar
Alex Wenckus committed
15
 */
16
package org.jivesoftware.openfire.commands.admin.muc;
Alex Wenckus's avatar
Alex Wenckus committed
17

18 19
import org.dom4j.Element;
import org.jivesoftware.openfire.XMPPServer;
20 21
import org.jivesoftware.openfire.commands.AdHocCommand;
import org.jivesoftware.openfire.commands.SessionData;
22
import org.jivesoftware.openfire.muc.MUCRoom;
23
import org.jivesoftware.openfire.muc.MultiUserChatService;
24
import org.jivesoftware.openfire.muc.NotAllowedException;
Alex Wenckus's avatar
Alex Wenckus committed
25 26
import org.xmpp.forms.DataForm;
import org.xmpp.forms.FormField;
27
import org.xmpp.packet.JID;
Alex Wenckus's avatar
Alex Wenckus committed
28

29
import java.util.Collection;
30
import java.util.Collections;
Alex Wenckus's avatar
Alex Wenckus committed
31 32 33 34 35 36 37 38 39
import java.util.List;
import java.util.Map;

/**
 * Allows via AdHoc commands the creation of a Multi-User Chat room.
 *
 * @author Alexander Wenckus
 */
public class CreateMUCRoom extends AdHocCommand {
40 41
    @Override
	public String getCode() {
Alex Wenckus's avatar
Alex Wenckus committed
42 43 44
        return "http://jabber.org/protocol/admin#create-muc-room";
    }

45 46
    @Override
	public String getDefaultLabel() {
Alex Wenckus's avatar
Alex Wenckus committed
47 48 49
        return "Create a Multi-user Chat";
    }

50 51
    @Override
	public int getMaxStages(SessionData data) {
Alex Wenckus's avatar
Alex Wenckus committed
52 53 54
        return 1;
    }

55 56
    @Override
	public void execute(SessionData sessionData, Element command) {
Alex Wenckus's avatar
Alex Wenckus committed
57 58 59 60 61 62 63 64 65
        Element note = command.addElement("note");
        Collection<JID> admins = XMPPServer.getInstance().getAdmins();
        if (admins.size() <= 0) {
            note.addAttribute("type", "error");
            note.setText("Server needs admin user to be able to create rooms.");
            return;
        }
        Map<String, List<String>> data = sessionData.getData();

66 67 68 69 70 71 72 73 74 75
        // Let's find the requested MUC service to create the room in
        String servicehostname = get(data, "servicename", 0);
        if (servicehostname == null) {
            note.addAttribute("type", "error");
            note.setText("Service name must be specified.");
            return;
        }
        // Remove the server's domain name from the passed hostname
        String servicename = servicehostname.replace("."+XMPPServer.getInstance().getServerInfo().getXMPPDomain(), "");
        MultiUserChatService mucService;
76 77
        mucService = XMPPServer.getInstance().getMultiUserChatManager().getMultiUserChatService(servicename);
        if (mucService == null) {
78 79 80 81
            note.addAttribute("type", "error");
            note.setText("Invalid service name specified.");
            return;
        }
82 83 84 85 86
        if (!mucService.isServiceEnabled()) {
            note.addAttribute("type", "error");
            note.setText("Multi user chat is disabled for specified service.");
            return;
        }
Alex Wenckus's avatar
Alex Wenckus committed
87 88 89 90 91 92 93 94 95 96
        // Let's create the jid and check that they are a local user
        String roomname = get(data, "roomname", 0);
        if (roomname == null) {
            note.addAttribute("type", "error");
            note.setText("Room name must be specified.");
            return;
        }
        JID admin = admins.iterator().next();
        MUCRoom room;
        try {
97
            room = mucService.getChatRoom(roomname, admin);
Alex Wenckus's avatar
Alex Wenckus committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
        }
        catch (NotAllowedException e) {
            note.addAttribute("type", "error");
            note.setText("No permission to create rooms.");
            return;
        }

        boolean isPersistent = "1".equals(get(data, "persistent", 0));
        room.setPersistent(isPersistent);

        boolean isPublic = "1".equals(get(data, "public", 0));
        room.setPublicRoom(isPublic);

        String password = get(data, "password", 0);
        if (password != null) {
            room.setPassword(password);
        }
    }

117 118
    @Override
	protected void addStageInformation(SessionData data, Element command) {
Alex Wenckus's avatar
Alex Wenckus committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
        DataForm form = new DataForm(DataForm.Type.form);
        form.setTitle("Create a multi-user chat room");
        form.addInstruction("Fill out this form to create a multi-user chat room.");

        FormField field = form.addField();
        field.setType(FormField.Type.hidden);
        field.setVariable("FORM_TYPE");
        field.addValue("http://jabber.org/protocol/admin");

        field = form.addField();
        field.setType(FormField.Type.text_single);
        field.setLabel("The name of the room");
        field.setVariable("roomname");
        field.setRequired(true);

134 135 136 137 138 139
        field = form.addField();
        field.setType(FormField.Type.text_single);
        field.setLabel("The service (hostname) to create the room on");
        field.setVariable("servicename");
        field.setRequired(true);

Alex Wenckus's avatar
Alex Wenckus committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
        field = form.addField();
        field.setType(FormField.Type.text_private);
        field.setLabel("The password for this account");
        field.setVariable("password");

        field = form.addField();
        field.setType(FormField.Type.text_private);
        field.setLabel("Retype password");
        field.setVariable("password-verify");

        field = form.addField();
        field.setType(FormField.Type.boolean_type);
        field.setLabel("Room is persistent");
        field.setVariable("persistent");

        field = form.addField();
        field.setType(FormField.Type.boolean_type);
        field.setLabel("Is the room public");
        field.setVariable("public");

        // Add the form to the command
        command.add(form.getElement());
    }

164 165
    @Override
	protected List<Action> getActions(SessionData data) {
166
        return Collections.singletonList(Action.complete);
Alex Wenckus's avatar
Alex Wenckus committed
167 168
    }

169 170
    @Override
	protected Action getExecuteAction(SessionData data) {
Alex Wenckus's avatar
Alex Wenckus committed
171 172 173 174
        return AdHocCommand.Action.complete;
    }

}