ssi.h
Go to the documentation of this file.
1 /**
2  * @file ssi.h
3  * @brief SSI (Server Side Includes)
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.0
29  **/
30 
31 #ifndef _SSI_H
32 #define _SSI_H
33 
34 //Dependencies
35 #include "http/http_server.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //SSI related functions
43 error_t ssiExecuteScript(HttpConnection *connection, const char_t *uri, uint_t level);
44 
46  const char_t *tag, size_t length, const char_t *uri, uint_t level);
47 
49  const char_t *tag, size_t length, const char_t *uri, uint_t level);
50 
51 error_t ssiProcessEchoCommand(HttpConnection *connection, const char_t *tag,
52  size_t length);
53 
54 error_t ssiProcessExecCommand(HttpConnection *connection, const char_t *tag,
55  size_t length);
56 
57 error_t ssiSearchTag(const char_t *s, size_t sLen, const char_t *tag,
58  size_t tagLen, size_t *pos);
59 
60 //C++ guard
61 #ifdef __cplusplus
62 }
63 #endif
64 
65 #endif
unsigned int uint_t
Definition: compiler_port.h:50
char char_t
Definition: compiler_port.h:48
error_t
Error codes.
Definition: error.h:43
HTTP server (HyperText Transfer Protocol)
#define HttpConnection
Definition: http_server.h:332
uint8_t s
Definition: ndp.h:345
error_t ssiSearchTag(const char_t *s, size_t sLen, const char_t *tag, size_t tagLen, size_t *pos)
Search a string for a given tag.
Definition: ssi.c:859
error_t ssiProcessCommand(HttpConnection *connection, const char_t *tag, size_t length, const char_t *uri, uint_t level)
Process SSI directive.
Definition: ssi.c:364
error_t ssiProcessEchoCommand(HttpConnection *connection, const char_t *tag, size_t length)
Process SSI echo directive.
Definition: ssi.c:602
error_t ssiProcessIncludeCommand(HttpConnection *connection, const char_t *tag, size_t length, const char_t *uri, uint_t level)
Process SSI include directive.
Definition: ssi.c:422
error_t ssiProcessExecCommand(HttpConnection *connection, const char_t *tag, size_t length)
Process SSI exec directive.
Definition: ssi.c:776
error_t ssiExecuteScript(HttpConnection *connection, const char_t *uri, uint_t level)
Execute SSI script.
Definition: ssi.c:67
uint8_t length
Definition: tcp.h:368