View Javadoc
1   /*
2    * Copyright 2016 The Lannister Project
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package net.anyflow.lannister.packetreceiver;
18  
19  import java.util.Date;
20  
21  import io.netty.channel.ChannelFutureListener;
22  import io.netty.channel.ChannelHandler.Sharable;
23  import io.netty.channel.ChannelHandlerContext;
24  import io.netty.channel.SimpleChannelInboundHandler;
25  import io.netty.handler.codec.mqtt.MqttMessage;
26  import io.netty.handler.codec.mqtt.MqttPublishMessage;
27  import net.anyflow.lannister.AbnormalDisconnectEventArgs;
28  import net.anyflow.lannister.Statistics;
29  import net.anyflow.lannister.message.InboundMessageStatus;
30  import net.anyflow.lannister.message.Message;
31  import net.anyflow.lannister.plugin.DisconnectEventListener;
32  import net.anyflow.lannister.plugin.IMessage;
33  import net.anyflow.lannister.plugin.Plugins;
34  import net.anyflow.lannister.plugin.PublishEventArgs;
35  import net.anyflow.lannister.plugin.PublishEventListener;
36  import net.anyflow.lannister.session.Session;
37  import net.anyflow.lannister.topic.Topic;
38  import net.anyflow.lannister.topic.TopicMatcher;
39  
40  @Sharable
41  public class PublishReceiver extends SimpleChannelInboundHandler<MqttPublishMessage> {
42  	private static final org.slf4j.Logger logger = org.slf4j.LoggerFactory.getLogger(PublishReceiver.class);
43  	public static final PublishReceiver INSTANCE = new PublishReceiver();
44  
45  	@Override
46  	protected void channelRead0(ChannelHandlerContext ctx, MqttPublishMessage msg) throws Exception {
47  		logger.debug("packet incoming [message={}]", msg.toString());
48  		Statistics.INSTANCE.add(Statistics.Criterion.MESSAGES_PUBLISH_RECEIVED, 1);
49  
50  		Session session = Session.NEXUS.get(ctx.channel().id());
51  		if (session == null) {
52  			logger.error("None exist session message [message={}]", msg.toString());
53  
54  			ctx.channel().disconnect().addListener(ChannelFutureListener.CLOSE).addListener(fs -> // [MQTT-4.8.0-1]
55  			Plugins.INSTANCE.get(DisconnectEventListener.class).disconnected(new AbnormalDisconnectEventArgs()));
56  			return;
57  		}
58  
59  		session.setLastIncomingTime(new Date());
60  
61  		if (!TopicMatcher.isValid(msg.variableHeader().topicName(), false)) {
62  			session.dispose(true);
63  			return;
64  		}
65  
66  		Message message = Message.newMessage(session.clientId(), msg);
67  
68  		if (!Plugins.INSTANCE.get(PublishEventListener.class).allowPublish(new PublishEventArgs() {
69  			@Override
70  			public IMessage message() {
71  				return message;
72  			}
73  		})) {
74  			session.dispose(true);
75  			return;
76  		}
77  
78  		// TODO What to do when sender re-publish message corrensponds to
79  		// unacked status?
80  
81  		// TODO Until it has received the corresponding PUBREL packet, the
82  		// Receiver MUST acknowledge any subsequent PUBLISH packet with the same
83  		// Packet Identifier by sending a PUBREC. It MUST NOT cause duplicate
84  		// messages to be delivered to any onward recipients in this
85  		// case.[MQTT-4.3.3-2].
86  
87  		final Topic topic = Topic.NEXUS.prepare(message);
88  
89  		if (message.isRetain()) {// else do nothing [MQTT-3.3.1-12]
90  			topic.setRetainedMessage(message); // [MQTT-3.3.1-5]
91  		}
92  
93  		message.setRetain(false);
94  
95  		topic.publish(message);
96  
97  		MqttMessage toSend;
98  		final String log;
99  
100 		switch (msg.fixedHeader().qosLevel()) {
101 		case AT_MOST_ONCE:
102 			return; // QoS 0 do not send any acknowledge packet [MQTT-3.3.4-1]
103 
104 		case AT_LEAST_ONCE:
105 			toSend = MqttMessageFactory.puback(msg.variableHeader().messageId());
106 			log = toSend.toString();
107 
108 			session.send(toSend, f -> {
109 				if (!f.isSuccess()) {
110 					logger.error("packet outgoing failed [{}] {}", log, f.cause());
111 					return;
112 				}
113 
114 				InboundMessageStatus.NEXUS.removeByKey(msg.variableHeader().messageId(), session.clientId());
115 			}); // [MQTT-3.3.4-1],[MQTT-2.3.1-6]
116 			logger.debug("Inbound message status REMOVED [clientId={}, messageId={}]", session.clientId(),
117 					msg.variableHeader().messageId());
118 			return;
119 
120 		case EXACTLY_ONCE:
121 			toSend = MqttMessageFactory.pubrec(msg.variableHeader().messageId());
122 			log = toSend.toString();
123 
124 			session.send(MqttMessageFactory.pubrec(msg.variableHeader().messageId()), f -> {
125 				if (!f.isSuccess()) {
126 					logger.error("packet outgoing failed [{}] {}", log, f.cause());
127 					return;
128 				}
129 
130 				InboundMessageStatus.NEXUS.update(msg.variableHeader().messageId(), session.clientId(),
131 						InboundMessageStatus.Status.PUBRECED);
132 			}); // [MQTT-3.3.4-1],[MQTT-2.3.1-6]
133 			return;
134 
135 		default:
136 			session.dispose(true); // [MQTT-3.3.1-4]
137 			return;
138 		}
139 	}
140 }