Annotation of libaitmqtt/src/pub.c, revision 1.1.1.1.2.1

1.1       misho       1: /*************************************************************************
                      2: * (C) 2011 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
                      3: *  by Michael Pounov <misho@openbsd-bg.org>
                      4: *
                      5: * $Author: misho $
1.1.1.1.2.1! misho       6: * $Id: pub.c,v 1.1.1.1 2012/01/26 13:07:33 misho Exp $
1.1       misho       7: *
                      8: **************************************************************************
                      9: The ELWIX and AITNET software is distributed under the following
                     10: terms:
                     11: 
                     12: All of the documentation and software included in the ELWIX and AITNET
                     13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
                     14: 
1.1.1.1.2.1! misho      15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
1.1       misho      16:        by Michael Pounov <misho@elwix.org>.  All rights reserved.
                     17: 
                     18: Redistribution and use in source and binary forms, with or without
                     19: modification, are permitted provided that the following conditions
                     20: are met:
                     21: 1. Redistributions of source code must retain the above copyright
                     22:    notice, this list of conditions and the following disclaimer.
                     23: 2. Redistributions in binary form must reproduce the above copyright
                     24:    notice, this list of conditions and the following disclaimer in the
                     25:    documentation and/or other materials provided with the distribution.
                     26: 3. All advertising materials mentioning features or use of this software
                     27:    must display the following acknowledgement:
                     28: This product includes software developed by Michael Pounov <misho@elwix.org>
                     29: ELWIX - Embedded LightWeight unIX and its contributors.
                     30: 4. Neither the name of AITNET nor the names of its contributors
                     31:    may be used to endorse or promote products derived from this software
                     32:    without specific prior written permission.
                     33: 
                     34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
                     35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     44: SUCH DAMAGE.
                     45: */
                     46: #include "global.h"
                     47: 
                     48: 
                     49: /*
                     50:  * mqtt_msgPUBLISH() Create PUBLISH message
                     51:  *
                     52:  * @buf = Message buffer
                     53:  * @csTopic = Publish topic
                     54:  * @msgID = MessageID >0, if QOS != MQTT_QOS_ONCE
                     55:  * @Dup = Duplicate message
                     56:  * @QOS = QoS
                     57:  * @Retain = Retain message
                     58:  * @pData = Publish data into topic
                     59:  * @datlen = Publish data length
                     60:  * return: -1 error or >-1 message size for send
                     61:  */
                     62: int
                     63: mqtt_msgPUBLISH(mqtt_msg_t * __restrict buf, const char *csTopic, u_short msgID, 
                     64:                u_char Dup, u_char QOS, u_char Retain, const void *pData, int datlen)
                     65: {
                     66:        int siz = 0;
                     67:        struct mqtthdr *hdr;
                     68:        mqtthdr_var_t *topic;
                     69:        mqtt_len_t *mid;
                     70:        void *data;
                     71: 
                     72:        if (!buf || !csTopic)
                     73:                return -1;
                     74:        if (QOS > MQTT_QOS_EXACTLY) {
1.1.1.1.2.1! misho      75:                mqtt_SetErr(EINVAL, "Invalid QoS parameter");
1.1       misho      76:                return -1;
                     77:        }
                     78:        if (!msgID && QOS != MQTT_QOS_ONCE) {
1.1.1.1.2.1! misho      79:                mqtt_SetErr(EINVAL, "Invalid MessageID parameter must be >0");
1.1       misho      80:                return -1;
                     81:        }
                     82: 
                     83:        if (mqtt_msgRealloc(buf, MQTTMSG_MAX) == -1)
                     84:                return -1;
                     85:        else {
                     86:                hdr = (struct mqtthdr *) (buf->msg_base + siz);
                     87:                siz += sizeof(struct mqtthdr);
                     88:        }
                     89: 
                     90:        /* variable header */
                     91:        topic = (mqtthdr_var_t*) (buf->msg_base + siz);
                     92:        topic->var_sb.val = htons(strlen(csTopic));
                     93:        memcpy(topic->var_data, csTopic, ntohs(topic->var_sb.val));
                     94:        siz += MQTTHDR_VAR_SIZEOF(topic);
                     95: 
                     96:        mid = (mqtt_len_t*) (buf->msg_base + siz);
                     97:        mid->val = htons(msgID);
                     98:        siz += sizeof(mqtt_len_t);
                     99: 
                    100:        /* load with data */
                    101:        if (pData && datlen) {
                    102:                data = buf->msg_base + siz;
                    103:                memcpy(data, pData, datlen);
                    104:                siz += datlen;
                    105:        }
                    106: 
                    107:        /* fixed header */
                    108:        MQTTHDR_MSGINIT(hdr);
                    109:        hdr->mqtt_msg.type = MQTT_TYPE_PUBLISH;
                    110:        hdr->mqtt_msg.qos = QOS;
                    111:        hdr->mqtt_msg.dup = Dup ? 1 : 0;
                    112:        hdr->mqtt_msg.retain = Retain ? 1 : 0;
                    113:        *hdr->mqtt_len = mqtt_encodeLen(siz - sizeof(struct mqtthdr));
                    114: 
                    115:        mqtt_msgRealloc(buf, siz);
                    116:        return siz;
                    117: }
                    118: 
                    119: static int
                    120: _mqtt_msgPUB_(mqtt_msg_t * __restrict buf, u_char cmd, u_short msgID)
                    121: {
                    122:        int siz = 0;
                    123:        struct mqtthdr *hdr;
                    124:        mqtt_len_t *v;
                    125: 
                    126:        if (!buf)
                    127:                return -1;
                    128: 
                    129:        if (mqtt_msgRealloc(buf, sizeof(struct mqtthdr) + sizeof(mqtt_len_t)) == -1)
                    130:                return -1;
                    131:        else {
                    132:                hdr = (struct mqtthdr *) (buf->msg_base + siz);
                    133:                siz += sizeof(struct mqtthdr);
                    134:                v = (mqtt_len_t*) (buf->msg_base + siz);
                    135:                siz += sizeof(mqtt_len_t);
                    136:        }
                    137: 
                    138:        /* fixed header */
                    139:        MQTTHDR_MSGINIT(hdr);
                    140:        hdr->mqtt_msg.type = cmd;
                    141:        *hdr->mqtt_len = sizeof(mqtt_len_t);
                    142: 
                    143:        /* MessageID */
                    144:        v->val = htons(msgID);
                    145: 
                    146:        return siz;
                    147: }
                    148: 
                    149: /*
                    150:  * mqtt_msgPUBACK() Create PUBACK message
                    151:  *
                    152:  * @buf = Message buffer
                    153:  * @msgID = MessageID
                    154:  * return: -1 error or >-1 message size for send
                    155:  */
                    156: inline int
                    157: mqtt_msgPUBACK(mqtt_msg_t * __restrict buf, u_short msgID)
                    158: {
                    159:        return _mqtt_msgPUB_(buf, MQTT_TYPE_PUBACK, msgID);
                    160: }
                    161: 
                    162: /*
                    163:  * mqtt_msgPUBREC() Create PUBREC message
                    164:  *
                    165:  * @buf = Message buffer
                    166:  * @msgID = MessageID
                    167:  * return: -1 error or >-1 message size for send
                    168:  */
                    169: inline int
                    170: mqtt_msgPUBREC(mqtt_msg_t * __restrict buf, u_short msgID)
                    171: {
                    172:        return _mqtt_msgPUB_(buf, MQTT_TYPE_PUBREC, msgID);
                    173: }
                    174: 
                    175: /*
                    176:  * mqtt_msgPUBREL() Create PUBREL message
                    177:  *
                    178:  * @buf = Message buffer
                    179:  * @msgID = MessageID
                    180:  * return: -1 error or >-1 message size for send
                    181:  */
                    182: inline int
                    183: mqtt_msgPUBREL(mqtt_msg_t * __restrict buf, u_short msgID)
                    184: {
                    185:        return _mqtt_msgPUB_(buf, MQTT_TYPE_PUBREL, msgID);
                    186: }
                    187: 
                    188: /*
                    189:  * mqtt_msgPUBCOMP() Create PUBCOMP message
                    190:  *
                    191:  * @buf = Message buffer
                    192:  * @msgID = MessageID
                    193:  * return: -1 error or >-1 message size for send
                    194:  */
                    195: inline int
                    196: mqtt_msgPUBCOMP(mqtt_msg_t * __restrict buf, u_short msgID)
                    197: {
                    198:        return _mqtt_msgPUB_(buf, MQTT_TYPE_PUBCOMP, msgID);
                    199: }
                    200: 
                    201: 
                    202: /* ============= decode ============ */
                    203: 
                    204: /*
                    205:  * mqtt_readPUBLISH() Read PUBLISH message
                    206:  *
                    207:  * @buf = Message buffer
                    208:  * @psTopic = Topic
                    209:  * @topicLen = Topic length
                    210:  * @msgID = MessageID
                    211:  * @pData = Data buffer
                    212:  * @datLen = Data buffer length, if *datLen == 0 allocate memory for pData
                    213:  * return: NULL error or !=NULL MQTT fixed header
                    214:  */
                    215: struct mqtthdr *
                    216: mqtt_readPUBLISH(mqtt_msg_t * __restrict buf, char * __restrict psTopic, int topicLen, 
                    217:                u_short *msgID, void * __restrict pData, int *datLen)
                    218: {
                    219:        int len, ret;
                    220:        struct mqtthdr *hdr;
                    221:        mqtthdr_var_t *var;
                    222:        mqtt_len_t *v;
                    223:        caddr_t pos;
                    224: 
                    225:        if (!buf || !psTopic || !msgID || !pData)
                    226:                return NULL;
                    227: 
                    228:        hdr = _mqtt_readHEADER(buf, MQTT_TYPE_PUBLISH, &ret, &len);
                    229:        if (!hdr)
                    230:                return NULL;
                    231:        pos = buf->msg_base + ret + 1;
                    232:        var = (mqtthdr_var_t*) pos;
                    233: 
                    234:        /* topic */
                    235:        len -= MQTTHDR_VAR_SIZEOF(var);
                    236:        if (len < 0) {
1.1.1.1.2.1! misho     237:                mqtt_SetErr(EINVAL, "Short message length %d", len);
1.1       misho     238:                return NULL;
                    239:        } else {
                    240:                memset(psTopic, 0, topicLen--);
                    241:                memcpy(psTopic, var->var_data, ntohs(var->var_sb.val) > topicLen ? 
                    242:                                topicLen : ntohs(var->var_sb.val));
                    243:                pos += MQTTHDR_VAR_SIZEOF(var);
                    244:                v = (mqtt_len_t*) pos;
                    245:        }
                    246: 
                    247:        len -= sizeof(mqtt_len_t);
                    248:        if (len < 0) {
1.1.1.1.2.1! misho     249:                mqtt_SetErr(EINVAL, "Short message length %d", len);
1.1       misho     250:                return NULL;
                    251:        } else {
                    252:                *msgID = ntohs(v->val);
                    253:                pos += sizeof(mqtt_len_t);
                    254:        }
                    255: 
                    256:        /* data */
                    257:        if (len < 0) {
1.1.1.1.2.1! misho     258:                mqtt_SetErr(EINVAL, "Short message length %d", len);
1.1       misho     259:                return NULL;
                    260:        } else {
                    261:                if (!*datLen) {
                    262:                        if (!(pData = malloc(len))) {
                    263:                                LOGERR;
                    264:                                return NULL;
                    265:                        } else
                    266:                                *datLen = len;
                    267:                }
                    268: 
                    269:                memset(pData, 0, *datLen);
                    270:                if (len < *datLen)
                    271:                        *datLen = len;
                    272:                memcpy(pData, pos, *datLen);
                    273:        }
                    274: 
                    275:        return hdr;
                    276: }
                    277: 
                    278: /*
                    279:  * mqtt_readPUBACK() Read PUBACK message
                    280:  *
                    281:  * @buf = Message buffer
                    282:  * return: -1 error or MessageID
                    283:  */
                    284: u_short
                    285: mqtt_readPUBACK(mqtt_msg_t * __restrict buf)
                    286: {
                    287:        int len, ret;
                    288:        struct mqtthdr *hdr;
                    289:        mqtt_len_t *v;
                    290:        caddr_t pos;
                    291: 
                    292:        hdr = _mqtt_readHEADER(buf, MQTT_TYPE_PUBACK, &ret, &len);
                    293:        if (!hdr)
                    294:                return (u_short) -1;
                    295:        if (len < sizeof(mqtt_len_t)) {
1.1.1.1.2.1! misho     296:                mqtt_SetErr(EINVAL, "Short message length %d", len);
1.1       misho     297:                return (u_short) -1;
                    298:        } else {
                    299:                pos = buf->msg_base + ret + 1;
                    300:                v = (mqtt_len_t*) pos;
                    301:        }
                    302: 
                    303:        return ntohs(v->val);
                    304: }
                    305: 
                    306: /*
                    307:  * mqtt_readPUBREC() Read PUBREC message
                    308:  *
                    309:  * @buf = Message buffer
                    310:  * return: -1 error or MessageID
                    311:  */
                    312: u_short
                    313: mqtt_readPUBREC(mqtt_msg_t * __restrict buf)
                    314: {
                    315:        int len, ret;
                    316:        struct mqtthdr *hdr;
                    317:        mqtt_len_t *v;
                    318:        caddr_t pos;
                    319: 
                    320:        hdr = _mqtt_readHEADER(buf, MQTT_TYPE_PUBREC, &ret, &len);
                    321:        if (!hdr)
                    322:                return (u_short) -1;
                    323:        if (len < sizeof(mqtt_len_t)) {
1.1.1.1.2.1! misho     324:                mqtt_SetErr(EINVAL, "Short message length %d", len);
1.1       misho     325:                return (u_short) -1;
                    326:        } else {
                    327:                pos = buf->msg_base + ret + 1;
                    328:                v = (mqtt_len_t*) pos;
                    329:        }
                    330: 
                    331:        return ntohs(v->val);
                    332: }
                    333: 
                    334: /*
                    335:  * mqtt_readPUBREL() Read PUBREL message
                    336:  *
                    337:  * @buf = Message buffer
                    338:  * return: -1 error or MessageID
                    339:  */
                    340: u_short
                    341: mqtt_readPUBREL(mqtt_msg_t * __restrict buf)
                    342: {
                    343:        int len, ret;
                    344:        struct mqtthdr *hdr;
                    345:        mqtt_len_t *v;
                    346:        caddr_t pos;
                    347: 
                    348:        hdr = _mqtt_readHEADER(buf, MQTT_TYPE_PUBREL, &ret, &len);
                    349:        if (!hdr)
                    350:                return (u_short) -1;
                    351:        if (len < sizeof(mqtt_len_t)) {
1.1.1.1.2.1! misho     352:                mqtt_SetErr(EINVAL, "Short message length %d", len);
1.1       misho     353:                return (u_short) -1;
                    354:        } else {
                    355:                pos = buf->msg_base + ret + 1;
                    356:                v = (mqtt_len_t*) pos;
                    357:        }
                    358: 
                    359:        return ntohs(v->val);
                    360: }
                    361: 
                    362: /*
                    363:  * mqtt_readPUBCOMP() Read PUBCOMP message
                    364:  *
                    365:  * @buf = Message buffer
                    366:  * return: -1 error or MessageID
                    367:  */
                    368: u_short
                    369: mqtt_readPUBCOMP(mqtt_msg_t * __restrict buf)
                    370: {
                    371:        int len, ret;
                    372:        struct mqtthdr *hdr;
                    373:        mqtt_len_t *v;
                    374:        caddr_t pos;
                    375: 
                    376:        hdr = _mqtt_readHEADER(buf, MQTT_TYPE_PUBCOMP, &ret, &len);
                    377:        if (!hdr)
                    378:                return (u_short) -1;
                    379:        if (len < sizeof(mqtt_len_t)) {
1.1.1.1.2.1! misho     380:                mqtt_SetErr(EINVAL, "Short message length %d", len);
1.1       misho     381:                return (u_short) -1;
                    382:        } else {
                    383:                pos = buf->msg_base + ret + 1;
                    384:                v = (mqtt_len_t*) pos;
                    385:        }
                    386: 
                    387:        return ntohs(v->val);
                    388: }

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>