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