1/*
2 * This program is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU General Public License as
4 * published by the Free Software Foundation; either version 2 of
5 * the License, or (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
15 * MA 02111-1307 USA
16 */
17#ifndef VSF_BANNER_H
18#define VSF_BANNER_H
19
20struct vsf_session;
21struct mystr;
22
23/* vsf_banner_dir_changed()
24 * PURPOSE
25 * This function, when called, will check if the current directory has just
26 * been entered for the first time in this session. If so, and message file
27 * support is on, a message file is looked for (default .message), and output
28 * to the FTP control connection with the FTP code prefix specified by
29 * "ftpcode".
30 * PARAMETERS
31 * p_sess         - the current FTP session object
32 * ftpcode        - the FTP code to show with the message
33 */
34void vsf_banner_dir_changed(struct vsf_session* p_sess, int ftpcode);
35
36/* vsf_banner_write()
37 * PURPOSE
38 * This function, when called, will write the specified string as a multiline
39 * FTP banner, using the specified FTP response code.
40 * PARAMETERS
41 * p_sess         - the current FTP session object
42 * p_str          - the string to write
43 * ftpcode        - the FTP code to show with the message
44 */
45void vsf_banner_write(struct vsf_session* p_sess, struct mystr* p_str,
46                      int ftpcode);
47
48#endif /* VSF_BANNER_H */
49
50