001/**
002 *
003 * Copyright 2013-2014 Georg Lukas, 2020 Florian Schmaus.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smackx.carbons.provider;
018
019import java.io.IOException;
020
021import org.jivesoftware.smack.packet.Message;
022import org.jivesoftware.smack.packet.XmlEnvironment;
023import org.jivesoftware.smack.parsing.SmackParsingException;
024import org.jivesoftware.smack.provider.ExtensionElementProvider;
025import org.jivesoftware.smack.xml.XmlPullParser;
026import org.jivesoftware.smack.xml.XmlPullParserException;
027
028import org.jivesoftware.smackx.carbons.packet.CarbonExtension;
029import org.jivesoftware.smackx.carbons.packet.CarbonExtension.Direction;
030import org.jivesoftware.smackx.forward.packet.Forwarded;
031import org.jivesoftware.smackx.forward.provider.ForwardedProvider;
032
033/**
034 * This class implements the {@link ExtensionElementProvider} to parse
035 * carbon copied messages from a packet.  It will return a {@link CarbonExtension} stanza extension.
036 *
037 * @author Georg Lukas
038 *
039 */
040public class CarbonManagerProvider extends ExtensionElementProvider<CarbonExtension> {
041
042    @Override
043    public CarbonExtension parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException {
044        Direction dir = Direction.valueOf(parser.getName());
045        Forwarded<Message> fwd = null;
046
047        boolean done = false;
048        while (!done) {
049            XmlPullParser.Event eventType = parser.next();
050            if (eventType == XmlPullParser.Event.START_ELEMENT && parser.getName().equals("forwarded")) {
051                fwd = ForwardedProvider.parseForwardedMessage(parser, xmlEnvironment);
052            }
053            else if (eventType == XmlPullParser.Event.END_ELEMENT && dir == Direction.valueOf(parser.getName()))
054                done = true;
055        }
056        if (fwd == null) {
057            throw new SmackParsingException("sent/received must contain exactly one <forwarded/> element");
058        }
059        return new CarbonExtension(dir, fwd);
060    }
061}