lws-misc.h

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010-2018 Andy Green <andy@warmcat.com>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation:
 *  version 2.1 of the License.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 *  MA  02110-1301  USA
 *
 * included from libwebsockets.h
 */
 
 
#define lws_start_foreach_ll(type, it, start)\
{ \
        type it = start; \
        while (it) {
 
#define lws_end_foreach_ll(it, nxt) \
                it = it->nxt; \
        } \
}
 
#define lws_start_foreach_ll_safe(type, it, start, nxt)\
{ \
        type it = start; \
        while (it) { \
                type next_##it = it->nxt;
 
#define lws_end_foreach_ll_safe(it) \
                it = next_##it; \
        } \
}
 
#define lws_start_foreach_llp(type, it, start)\
{ \
        type it = &(start); \
        while (*(it)) {
 
#define lws_start_foreach_llp_safe(type, it, start, nxt)\
{ \
        type it = &(start); \
        type next; \
        while (*(it)) { \
                next = &((*(it))->nxt); \
 
 
#define lws_end_foreach_llp(it, nxt) \
                it = &(*(it))->nxt; \
        } \
}
 
#define lws_end_foreach_llp_safe(it) \
                it = next; \
        } \
}
 
#define lws_ll_fwd_insert(\
        ___new_object,  /* pointer to new object */ \
        ___m_list,      /* member for next list object ptr */ \
        ___list_head    /* list head */ \
                ) {\
                ___new_object->___m_list = ___list_head; \
                ___list_head = ___new_object; \
        }
 
#define lws_ll_fwd_remove(\
        ___type,        /* type of listed object */ \
        ___m_list,      /* member for next list object ptr */ \
        ___target,      /* object to remove from list */ \
        ___list_head    /* list head */ \
        ) { \
                lws_start_foreach_llp(___type **, ___ppss, ___list_head) { \
                        if (*___ppss == ___target) { \
                                *___ppss = ___target->___m_list; \
                                break; \
                        } \
                } lws_end_foreach_llp(___ppss, ___m_list); \
        }
 
/*
 * doubly linked-list
 */
 
struct lws_dll { /* abstract */
        struct lws_dll *prev;
        struct lws_dll *next;
};
 
/*
 * these all point to the composed list objects... you have to use the
 * lws_container_of() helper to recover the start of the containing struct
 */
 
LWS_VISIBLE LWS_EXTERN void
lws_dll_add_front(struct lws_dll *d, struct lws_dll *phead);
 
LWS_VISIBLE LWS_EXTERN void
lws_dll_remove(struct lws_dll *d);
 
struct lws_dll_lws { /* typed as struct lws * */
        struct lws_dll_lws *prev;
        struct lws_dll_lws *next;
};
 
#define lws_dll_is_null(___dll) (!(___dll)->prev && !(___dll)->next)
 
static LWS_INLINE void
lws_dll_lws_add_front(struct lws_dll_lws *_a, struct lws_dll_lws *_head)
{
        lws_dll_add_front((struct lws_dll *)_a, (struct lws_dll *)_head);
}
 
static LWS_INLINE void
lws_dll_lws_remove(struct lws_dll_lws *_a)
{
        lws_dll_remove((struct lws_dll *)_a);
}
 
/*
 * these are safe against the current container object getting deleted,
 * since the hold his next in a temp and go to that next.  ___tmp is
 * the temp.
 */
 
#define lws_start_foreach_dll_safe(___type, ___it, ___tmp, ___start) \
{ \
        ___type ___it = ___start; \
        while (___it) { \
                ___type ___tmp = (___it)->next;
 
#define lws_end_foreach_dll_safe(___it, ___tmp) \
                ___it = ___tmp; \
        } \
}
 
#define lws_start_foreach_dll(___type, ___it, ___start) \
{ \
        ___type ___it = ___start; \
        while (___it) {
 
#define lws_end_foreach_dll(___it) \
                ___it = (___it)->next; \
        } \
}
 
struct lws_buflist;
 
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
lws_buflist_append_segment(struct lws_buflist **head, const uint8_t *buf,
                           size_t len);
LWS_VISIBLE LWS_EXTERN size_t
lws_buflist_next_segment_len(struct lws_buflist **head, uint8_t **buf);
LWS_VISIBLE LWS_EXTERN int
lws_buflist_use_segment(struct lws_buflist **head, size_t len);
LWS_VISIBLE LWS_EXTERN void
lws_buflist_destroy_all_segments(struct lws_buflist **head);
 
void
lws_buflist_describe(struct lws_buflist **head, void *id);
 
#define lws_ptr_diff(head, tail) \
                        ((int)((char *)(head) - (char *)(tail)))
 
LWS_VISIBLE LWS_EXTERN int
lws_snprintf(char *str, size_t size, const char *format, ...) LWS_FORMAT(3);
 
LWS_VISIBLE LWS_EXTERN char *
lws_strncpy(char *dest, const char *src, size_t size);
 
LWS_VISIBLE LWS_EXTERN int
lws_get_random(struct lws_context *context, void *buf, int len);
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
lws_daemonize(const char *_lock_path);
LWS_VISIBLE LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
lws_get_library_version(void);
 
LWS_VISIBLE LWS_EXTERN void *
lws_wsi_user(struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN void
lws_set_wsi_user(struct lws *wsi, void *user);
 
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
lws_parse_uri(char *p, const char **prot, const char **ads, int *port,
              const char **path);
LWS_VISIBLE LWS_EXTERN const char *
lws_cmdline_option(int argc, const char **argv, const char *val);
 
LWS_VISIBLE LWS_EXTERN unsigned long
lws_now_secs(void);
 
LWS_VISIBLE LWS_EXTERN lws_usec_t
lws_now_usecs(void);
 
LWS_VISIBLE LWS_EXTERN int
lws_compare_time_t(struct lws_context *context, time_t t1, time_t t2);
 
LWS_VISIBLE LWS_EXTERN struct lws_context * LWS_WARN_UNUSED_RESULT
lws_get_context(const struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
lws_get_vhost_listen_port(struct lws_vhost *vhost);
 
LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT
lws_get_count_threads(struct lws_context *context);
 
LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
lws_get_parent(const struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
lws_get_child(const struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN void
lws_get_effective_uid_gid(struct lws_context *context, int *uid, int *gid);
 
LWS_VISIBLE LWS_EXTERN const struct lws_udp * LWS_WARN_UNUSED_RESULT
lws_get_udp(const struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN void *
lws_get_opaque_parent_data(const struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN void
lws_set_opaque_parent_data(struct lws *wsi, void *data);
 
LWS_VISIBLE LWS_EXTERN int
lws_get_child_pending_on_writable(const struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN void
lws_clear_child_pending_on_writable(struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN int
lws_get_close_length(struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN unsigned char *
lws_get_close_payload(struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN
struct lws *lws_get_network_wsi(struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN void
lws_set_allocator(void *(*realloc)(void *ptr, size_t size, const char *reason));
 
enum {
        /*
         * Flags for enable and disable rxflow with reason bitmap and with
         * backwards-compatible single bool
         */
        LWS_RXFLOW_REASON_USER_BOOL             = (1 << 0),
        LWS_RXFLOW_REASON_HTTP_RXBUFFER         = (1 << 6),
        LWS_RXFLOW_REASON_H2_PPS_PENDING        = (1 << 7),
 
        LWS_RXFLOW_REASON_APPLIES               = (1 << 14),
        LWS_RXFLOW_REASON_APPLIES_ENABLE_BIT    = (1 << 13),
        LWS_RXFLOW_REASON_APPLIES_ENABLE        = LWS_RXFLOW_REASON_APPLIES |
                                                  LWS_RXFLOW_REASON_APPLIES_ENABLE_BIT,
        LWS_RXFLOW_REASON_APPLIES_DISABLE       = LWS_RXFLOW_REASON_APPLIES,
        LWS_RXFLOW_REASON_FLAG_PROCESS_NOW      = (1 << 12),
 
};
 
LWS_VISIBLE LWS_EXTERN int
lws_rx_flow_control(struct lws *wsi, int enable);
 
LWS_VISIBLE LWS_EXTERN void
lws_rx_flow_allow_all_protocol(const struct lws_context *context,
                               const struct lws_protocols *protocol);
 
LWS_VISIBLE LWS_EXTERN size_t
lws_remaining_packet_payload(struct lws *wsi);
 
 
 
LWS_VISIBLE LWS_EXTERN int
lws_is_ssl(struct lws *wsi);
LWS_VISIBLE LWS_EXTERN int
lws_is_cgi(struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN int
lws_open(const char *__file, int __oflag, ...);
 
struct lws_wifi_scan { /* generic wlan scan item */
        struct lws_wifi_scan *next;
        char ssid[32];
        int32_t rssi; /* divide by .count to get db */
        uint8_t bssid[6];
        uint8_t count;
        uint8_t channel;
        uint8_t authmode;
};
 
#if defined(LWS_WITH_TLS) && !defined(LWS_WITH_MBEDTLS)
 
LWS_VISIBLE LWS_EXTERN SSL*
lws_get_ssl(struct lws *wsi);
#endif
 
#ifdef LWS_WITH_SMTP
 
enum lwsgs_smtp_states {
        LGSSMTP_IDLE, 
        LGSSMTP_CONNECTING, 
        LGSSMTP_CONNECTED, 
        LGSSMTP_SENT_HELO, 
        LGSSMTP_SENT_FROM, 
        LGSSMTP_SENT_TO, 
        LGSSMTP_SENT_DATA, 
        LGSSMTP_SENT_BODY, 
        LGSSMTP_SENT_QUIT, 
};
 
struct lws_email {
        void *data;
        uv_loop_t *loop;
        char email_smtp_ip[32]; 
        char email_helo[32];    
        char email_from[100];   
        char email_to[100];     
        unsigned int max_content_size;
        /* Fill all the callbacks before init */
 
        int (*on_next)(struct lws_email *email);
        int (*on_sent)(struct lws_email *email);
        int (*on_get_body)(struct lws_email *email, char *buf, int len);
        /* private things */
        uv_timer_t timeout_email; 
        enum lwsgs_smtp_states estate; 
        uv_connect_t email_connect_req; 
        uv_tcp_t email_client; 
        time_t email_connect_started; 
        char email_buf[256]; 
        char *content; 
};
 
LWS_VISIBLE LWS_EXTERN int
lws_email_init(struct lws_email *email, uv_loop_t *loop, int max_content);
 
LWS_VISIBLE LWS_EXTERN void
lws_email_check(struct lws_email *email);
LWS_VISIBLE LWS_EXTERN void
lws_email_destroy(struct lws_email *email);
 
#endif