001/**
002 *
003 * Copyright 2016 Fernando Ramirez, 2020-2021 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.mam.provider;
018
019import java.io.IOException;
020import java.text.ParseException;
021
022import org.jivesoftware.smack.packet.Message;
023import org.jivesoftware.smack.packet.XmlEnvironment;
024import org.jivesoftware.smack.parsing.SmackParsingException;
025import org.jivesoftware.smack.provider.ExtensionElementProvider;
026import org.jivesoftware.smack.xml.XmlPullParser;
027import org.jivesoftware.smack.xml.XmlPullParserException;
028
029import org.jivesoftware.smackx.forward.packet.Forwarded;
030import org.jivesoftware.smackx.forward.provider.ForwardedProvider;
031import org.jivesoftware.smackx.mam.element.MamElementFactory;
032import org.jivesoftware.smackx.mam.element.MamElements.MamResultExtension;
033
034/**
035 * MAM Result Provider class.
036 *
037 * @see <a href="http://xmpp.org/extensions/xep-0313.html">XEP-0313: Message
038 *      Archive Management</a>
039 * @author Fernando Ramirez
040 *
041 */
042public class MamResultProvider extends ExtensionElementProvider<MamResultExtension> {
043
044    @Override
045    public MamResultExtension parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment)
046                    throws XmlPullParserException, IOException, SmackParsingException, ParseException {
047        MamElementFactory elementFactory = MamElementFactory.forParser(parser);
048        Forwarded<Message> forwarded = null;
049        String queryId = parser.getAttributeValue("", "queryid");
050        String id = parser.getAttributeValue("", "id");
051
052        outerloop: while (true) {
053            final XmlPullParser.Event eventType = parser.next();
054            switch (eventType) {
055            case START_ELEMENT:
056                final String name = parser.getName();
057                switch (name) {
058                case Forwarded.ELEMENT:
059                    forwarded = ForwardedProvider.parseForwardedMessage(parser, xmlEnvironment);
060                    break;
061                }
062                break;
063            case END_ELEMENT:
064                if (parser.getDepth() == initialDepth) {
065                    break outerloop;
066                }
067                break;
068            default:
069                // Catch all for incomplete switch (MissingCasesInEnumSwitch) statement.
070                break;
071            }
072        }
073
074        return elementFactory.newResultExtension(queryId, id, forwarded);
075    }
076
077}