2 * Server functions which handle file transfers and room directories.
4 * Copyright (c) 1987-2016 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 #include <libcitadel.h>
19 #include "ctdl_module.h"
20 #include "citserver.h"
27 * Server command to delete a file from a room's directory
29 void cmd_delf(char *filename)
34 if (CtdlAccessCheck(ac_room_aide))
37 if ((CC->room.QRflags & QR_DIRECTORY) == 0) {
38 cprintf("%d No directory in this room.\n",
43 if (IsEmptyStr(filename)) {
44 cprintf("%d You must specify a file name.\n",
45 ERROR + FILE_NOT_FOUND);
48 for (a = 0; !IsEmptyStr(&filename[a]); ++a) {
49 if ( (filename[a] == '/') || (filename[a] == '\\') ) {
53 snprintf(pathname, sizeof pathname,
56 CC->room.QRdirname, filename);
59 cprintf("%d File '%s' deleted.\n", CIT_OK, pathname);
62 cprintf("%d File '%s' not found.\n",
63 ERROR + FILE_NOT_FOUND, pathname);
71 * move a file from one room directory to another
73 void cmd_movf(char *cmdbuf)
75 char filename[PATH_MAX];
76 char pathname[PATH_MAX];
77 char newpath[PATH_MAX];
78 char newroom[ROOMNAMELEN];
81 struct ctdlroom qrbuf;
83 extract_token(filename, cmdbuf, 0, '|', sizeof filename);
84 extract_token(newroom, cmdbuf, 1, '|', sizeof newroom);
86 if (CtdlAccessCheck(ac_room_aide)) return;
88 if ((CC->room.QRflags & QR_DIRECTORY) == 0) {
89 cprintf("%d No directory in this room.\n",
94 if (IsEmptyStr(filename)) {
95 cprintf("%d You must specify a file name.\n",
96 ERROR + FILE_NOT_FOUND);
100 for (a = 0; !IsEmptyStr(&filename[a]); ++a) {
101 if ( (filename[a] == '/') || (filename[a] == '\\') ) {
105 snprintf(pathname, sizeof pathname, "./files/%s/%s",
106 CC->room.QRdirname, filename);
107 if (access(pathname, 0) != 0) {
108 cprintf("%d File '%s' not found.\n",
109 ERROR + FILE_NOT_FOUND, pathname);
113 if (CtdlGetRoom(&qrbuf, newroom) != 0) {
114 cprintf("%d '%s' does not exist.\n", ERROR + ROOM_NOT_FOUND, newroom);
117 if ((qrbuf.QRflags & QR_DIRECTORY) == 0) {
118 cprintf("%d '%s' is not a directory room.\n",
119 ERROR + NOT_HERE, qrbuf.QRname);
122 snprintf(newpath, sizeof newpath, "./files/%s/%s", qrbuf.QRdirname,
124 if (link(pathname, newpath) != 0) {
125 cprintf("%d Couldn't move file: %s\n", ERROR + INTERNAL_ERROR,
131 /* this is a crude method of copying the file description */
132 snprintf(buf, sizeof buf,
133 "cat ./files/%s/filedir |grep \"%s\" >>./files/%s/filedir",
134 CC->room.QRdirname, filename, qrbuf.QRdirname);
136 cprintf("%d File '%s' has been moved.\n", CIT_OK, filename);
141 * This code is common to all commands which open a file for downloading,
142 * regardless of whether it's a file from the directory, an image, a network
143 * spool file, a MIME attachment, etc.
144 * It examines the file and displays the OK result code and some information
145 * about the file. NOTE: this stuff is Unix dependent.
147 void OpenCmdResult(char *filename, const char *mime_type)
153 fstat(fileno(CC->download_fp), &statbuf);
154 CC->download_fp_total = statbuf.st_size;
155 filesize = (long) statbuf.st_size;
156 modtime = (time_t) statbuf.st_mtime;
158 cprintf("%d %ld|%ld|%s|%s\n",
159 CIT_OK, filesize, (long)modtime, filename, mime_type);
164 * open a file for downloading
166 void cmd_open(char *cmdbuf)
169 char pathname[PATH_MAX];
172 extract_token(filename, cmdbuf, 0, '|', sizeof filename);
174 if (CtdlAccessCheck(ac_logged_in)) return;
176 if ((CC->room.QRflags & QR_DIRECTORY) == 0) {
177 cprintf("%d No directory in this room.\n",
182 if (IsEmptyStr(filename)) {
183 cprintf("%d You must specify a file name.\n",
184 ERROR + FILE_NOT_FOUND);
187 if (strstr(filename, "../") != NULL)
189 cprintf("%d syntax error.\n",
190 ERROR + ILLEGAL_VALUE);
194 if (CC->download_fp != NULL) {
195 cprintf("%d You already have a download file open.\n",
196 ERROR + RESOURCE_BUSY);
200 for (a = 0; !IsEmptyStr(&filename[a]); ++a) {
201 if ( (filename[a] == '/') || (filename[a] == '\\') ) {
206 snprintf(pathname, sizeof pathname,
209 CC->room.QRdirname, filename);
210 CC->download_fp = fopen(pathname, "r");
212 if (CC->download_fp == NULL) {
213 cprintf("%d cannot open %s: %s\n",
214 ERROR + INTERNAL_ERROR, pathname, strerror(errno));
218 OpenCmdResult(filename, "application/octet-stream");
224 void cmd_oimg(char *cmdbuf)
226 char filename[PATH_MAX];
227 char pathname[PATH_MAX];
228 char MimeTestBuf[32];
232 extract_token(filename, cmdbuf, 0, '|', sizeof filename);
234 if (IsEmptyStr(filename)) {
235 cprintf("%d You must specify a file name.\n",
236 ERROR + FILE_NOT_FOUND);
240 if (CC->download_fp != NULL) {
241 cprintf("%d You already have a download file open.\n",
242 ERROR + RESOURCE_BUSY);
246 if (!strcasecmp(filename, "_roompic_")) {
247 assoc_file_name(pathname, sizeof pathname, &CC->room, ctdl_image_dir);
250 for (a = 0; !IsEmptyStr(&filename[a]); ++a) {
251 filename[a] = tolower(filename[a]);
252 if ( (filename[a] == '/') || (filename[a] == '\\') ) {
256 if (strstr(filename, "../") != NULL)
258 cprintf("%d syntax error.\n",
259 ERROR + ILLEGAL_VALUE);
263 snprintf(pathname, sizeof pathname,
269 CC->download_fp = fopen(pathname, "rb");
270 if (CC->download_fp == NULL) {
271 strcat(pathname, ".gif");
272 CC->download_fp = fopen(pathname, "rb");
274 if (CC->download_fp == NULL) {
275 cprintf("%d Cannot open %s: %s\n",
276 ERROR + FILE_NOT_FOUND, pathname, strerror(errno));
279 rv = fread(&MimeTestBuf[0], 1, 32, CC->download_fp);
281 cprintf("%d Cannot access %s: %s\n",
282 ERROR + FILE_NOT_FOUND, pathname, strerror(errno));
286 rewind (CC->download_fp);
287 OpenCmdResult(pathname, GuessMimeType(&MimeTestBuf[0], 32));
292 * open a file for uploading
294 void cmd_uopn(char *cmdbuf)
298 extract_token(CC->upl_file, cmdbuf, 0, '|', sizeof CC->upl_file);
299 extract_token(CC->upl_mimetype, cmdbuf, 1, '|', sizeof CC->upl_mimetype);
300 extract_token(CC->upl_comment, cmdbuf, 2, '|', sizeof CC->upl_comment);
302 if (CtdlAccessCheck(ac_logged_in)) return;
304 if ((CC->room.QRflags & QR_DIRECTORY) == 0) {
305 cprintf("%d No directory in this room.\n",
310 if (IsEmptyStr(CC->upl_file)) {
311 cprintf("%d You must specify a file name.\n",
312 ERROR + FILE_NOT_FOUND);
316 if (CC->upload_fp != NULL) {
317 cprintf("%d You already have a upload file open.\n",
318 ERROR + RESOURCE_BUSY);
322 for (a = 0; !IsEmptyStr(&CC->upl_file[a]); ++a) {
323 if ( (CC->upl_file[a] == '/') || (CC->upl_file[a] == '\\') ) {
324 CC->upl_file[a] = '_';
327 snprintf(CC->upl_path, sizeof CC->upl_path,
330 CC->room.QRdirname, CC->upl_file);
331 snprintf(CC->upl_filedir, sizeof CC->upl_filedir,
336 CC->upload_fp = fopen(CC->upl_path, "r");
337 if (CC->upload_fp != NULL) {
338 fclose(CC->upload_fp);
339 CC->upload_fp = NULL;
340 cprintf("%d '%s' already exists\n",
341 ERROR + ALREADY_EXISTS, CC->upl_path);
345 CC->upload_fp = fopen(CC->upl_path, "wb");
346 if (CC->upload_fp == NULL) {
347 cprintf("%d Cannot open %s: %s\n",
348 ERROR + INTERNAL_ERROR, CC->upl_path, strerror(errno));
351 cprintf("%d Ok\n", CIT_OK);
357 * open an image file for uploading
359 void cmd_uimg(char *cmdbuf)
361 int is_this_for_real;
365 if (num_parms(cmdbuf) < 2) {
366 cprintf("%d Usage error.\n", ERROR + ILLEGAL_VALUE);
370 is_this_for_real = extract_int(cmdbuf, 0);
371 extract_token(CC->upl_mimetype, cmdbuf, 1, '|', sizeof CC->upl_mimetype);
372 extract_token(basenm, cmdbuf, 2, '|', sizeof basenm);
373 if (CC->upload_fp != NULL) {
374 cprintf("%d You already have an upload file open.\n",
375 ERROR + RESOURCE_BUSY);
379 strcpy(CC->upl_path, "");
381 for (a = 0; !IsEmptyStr(&basenm[a]); ++a) {
382 basenm[a] = tolower(basenm[a]);
383 if ( (basenm[a] == '/') || (basenm[a] == '\\') ) {
388 if (CC->user.axlevel >= AxAideU) {
389 snprintf(CC->upl_path, sizeof CC->upl_path,
395 if ((!strcasecmp(basenm, "_roompic_")) && (is_room_aide())) {
396 assoc_file_name(CC->upl_path, sizeof CC->upl_path, &CC->room, ctdl_image_dir);
399 if (IsEmptyStr(CC->upl_path)) {
400 cprintf("%d Higher access required.\n",
401 ERROR + HIGHER_ACCESS_REQUIRED);
405 if (is_this_for_real == 0) {
406 cprintf("%d Ok to send image\n", CIT_OK);
410 CC->upload_fp = fopen(CC->upl_path, "wb");
411 if (CC->upload_fp == NULL) {
412 cprintf("%d Cannot open %s: %s\n",
413 ERROR + INTERNAL_ERROR, CC->upl_path, strerror(errno));
416 cprintf("%d Ok\n", CIT_OK);
417 CC->upload_type = UPL_IMAGE;
422 * close the download file
424 void cmd_clos(char *cmdbuf)
428 if (CC->download_fp == NULL) {
429 cprintf("%d You don't have a download file open.\n",
430 ERROR + RESOURCE_NOT_OPEN);
434 fclose(CC->download_fp);
435 CC->download_fp = NULL;
437 if (CC->dl_is_net == 1) {
439 snprintf(buf, sizeof buf,
446 cprintf("%d Ok\n", CIT_OK);
453 void abort_upl(CitContext *who)
455 if (who->upload_fp != NULL) {
456 fclose(who->upload_fp);
457 who->upload_fp = NULL;
458 unlink(CC->upl_path);
465 * close the upload file
467 void cmd_ucls(char *cmd)
469 struct CitContext *CCC = CC;
471 char upload_notice[512];
474 if (CCC->upload_fp == NULL) {
475 cprintf("%d You don't have an upload file open.\n", ERROR + RESOURCE_NOT_OPEN);
479 fclose(CC->upload_fp);
480 CCC->upload_fp = NULL;
482 if ((!strcasecmp(cmd, "1")) && (CCC->upload_type != UPL_FILE)) {
483 cprintf("%d Upload completed.\n", CIT_OK);
485 if (CCC->upload_type == UPL_NET) {
486 char final_filename[PATH_MAX];
487 snprintf(final_filename, sizeof final_filename,
495 if (link(CCC->upl_path, final_filename) == 0) {
496 CTDL_syslog(LOG_INFO, "UCLS: updoaded %s",
498 unlink(CCC->upl_path);
501 CTDL_syslog(LOG_INFO, "Cannot link %s to %s: %s",
502 CCC->upl_path, final_filename, strerror(errno)
507 /* FIXME ... here we need to trigger a network run */
510 CCC->upload_type = UPL_FILE;
514 if (!strcasecmp(cmd, "1")) {
515 cprintf("%d File '%s' saved.\n", CIT_OK, CCC->upl_path);
516 fp = fopen(CCC->upl_filedir, "a");
518 fp = fopen(CCC->upl_filedir, "w");
521 fprintf(fp, "%s %s %s\n", CCC->upl_file,
527 if ((CCC->room.QRflags2 & QR2_NOUPLMSG) == 0) {
528 /* put together an upload notice */
529 snprintf(upload_notice, sizeof upload_notice,
530 "NEW UPLOAD: '%s'\n %s\n%s\n",
534 quickie_message(CCC->curr_user, NULL, NULL, CCC->room.QRname,
535 upload_notice, 0, NULL);
539 cprintf("%d File '%s' aborted.\n", CIT_OK, CCC->upl_path);
545 * read from the download file
547 void cmd_read(char *cmdbuf)
554 /* The client will transmit its requested offset and byte count */
555 start_pos = extract_long(cmdbuf, 0);
556 bytes = extract_int(cmdbuf, 1);
557 if ((start_pos < 0) || (bytes <= 0)) {
558 cprintf("%d you have to specify a value > 0.\n", ERROR + ILLEGAL_VALUE);
562 if (CC->download_fp == NULL) {
563 cprintf("%d You don't have a download file open.\n",
564 ERROR + RESOURCE_NOT_OPEN);
568 /* If necessary, reduce the byte count to the size of our buffer */
569 if (bytes > sizeof(buf)) {
573 rc = fseek(CC->download_fp, start_pos, 0);
575 struct CitContext *CCC = CC;
576 cprintf("%d your file is smaller then %ld.\n", ERROR + ILLEGAL_VALUE, start_pos);
577 CTDL_syslog(LOG_ERR, "your file %s is smaller then %ld. [%s]\n",
584 bytes = fread(buf, 1, bytes, CC->download_fp);
586 /* Tell the client the actual byte count and transmit it */
587 cprintf("%d %d\n", BINARY_FOLLOWS, (int)bytes);
588 client_write(buf, bytes);
591 cprintf("%d %s\n", ERROR, strerror(errno));
597 * write to the upload file
599 void cmd_writ(char *cmdbuf)
601 struct CitContext *CCC = CC;
608 bytes = extract_int(cmdbuf, 0);
610 if (CCC->upload_fp == NULL) {
611 cprintf("%d You don't have an upload file open.\n", ERROR + RESOURCE_NOT_OPEN);
615 cprintf("%d you have to specify a value > 0.\n", ERROR + ILLEGAL_VALUE);
619 if (bytes > 100000) {
623 cprintf("%d %d\n", SEND_BINARY, bytes);
624 buf = malloc(bytes + 1);
625 client_read(buf, bytes);
626 rv = fwrite(buf, bytes, 1, CCC->upload_fp);
628 CTDL_syslog(LOG_EMERG, "Couldn't write: %s\n",
638 * cmd_ndop() - open a network spool file for downloading
640 void cmd_ndop(char *cmdbuf)
642 struct CitContext *CCC = CC;
646 if (IsEmptyStr(CCC->net_node)) {
647 cprintf("%d Not authenticated as a network node.\n",
648 ERROR + NOT_LOGGED_IN);
652 if (CCC->download_fp != NULL) {
653 cprintf("%d You already have a download file open.\n",
654 ERROR + RESOURCE_BUSY);
658 snprintf(pathname, sizeof pathname,
663 /* first open the file in append mode in order to create a
664 * zero-length file if it doesn't already exist
666 CCC->download_fp = fopen(pathname, "a");
667 if (CCC->download_fp != NULL)
668 fclose(CCC->download_fp);
671 CCC->download_fp = fopen(pathname, "r");
672 if (CCC->download_fp == NULL) {
673 cprintf("%d cannot open %s: %s\n",
674 ERROR + INTERNAL_ERROR, pathname, strerror(errno));
679 /* set this flag so other routines know that the download file
680 * currently open is a network spool file
684 stat(pathname, &statbuf);
685 CCC->download_fp_total = statbuf.st_size;
686 cprintf("%d %ld\n", CIT_OK, (long)statbuf.st_size);
690 * cmd_nuop() - open a network spool file for uploading
692 void cmd_nuop(char *cmdbuf)
696 if (IsEmptyStr(CC->net_node)) {
697 cprintf("%d Not authenticated as a network node.\n",
698 ERROR + NOT_LOGGED_IN);
702 if (CC->upload_fp != NULL) {
703 cprintf("%d You already have an upload file open.\n",
704 ERROR + RESOURCE_BUSY);
708 snprintf(CC->upl_path, sizeof CC->upl_path,
715 CC->upload_fp = fopen(CC->upl_path, "r");
716 if (CC->upload_fp != NULL) {
717 fclose(CC->upload_fp);
718 CC->upload_fp = NULL;
719 cprintf("%d '%s' already exists\n",
720 ERROR + ALREADY_EXISTS, CC->upl_path);
724 CC->upload_fp = fopen(CC->upl_path, "w");
725 if (CC->upload_fp == NULL) {
726 cprintf("%d Cannot open %s: %s\n",
727 ERROR + INTERNAL_ERROR, CC->upl_path, strerror(errno));
731 CC->upload_type = UPL_NET;
732 cprintf("%d Ok\n", CIT_OK);
734 void files_logout_hook(void)
736 CitContext *CCC = MyContext();
739 * If there is a download in progress, abort it.
741 if (CCC->download_fp != NULL) {
742 fclose(CCC->download_fp);
743 CCC->download_fp = NULL;
747 * If there is an upload in progress, abort it.
749 if (CCC->upload_fp != NULL) {
756 * help_subst() - support routine for help file viewer
758 void help_subst(char *strbuf, char *source, char *dest)
763 while (p = pattern2(strbuf, source), (p >= 0)) {
764 strcpy(workbuf, &strbuf[p + strlen(source)]);
765 strcpy(&strbuf[p], dest);
766 strcat(strbuf, workbuf);
770 void do_help_subst(char *buffer)
774 help_subst(buffer, "^nodename", CtdlGetConfigStr("c_nodename"));
775 help_subst(buffer, "^humannode", CtdlGetConfigStr("c_humannode"));
776 help_subst(buffer, "^fqdn", CtdlGetConfigStr("c_fqdn"));
777 help_subst(buffer, "^username", CC->user.fullname);
778 snprintf(buf2, sizeof buf2, "%ld", CC->user.usernum);
779 help_subst(buffer, "^usernum", buf2);
780 help_subst(buffer, "^sysadm", CtdlGetConfigStr("c_sysadm"));
781 help_subst(buffer, "^variantname", CITADEL);
782 help_subst(buffer, "^maxsessions", CtdlGetConfigStr("c_maxsessions")); // yes it's numeric but str is ok here
783 help_subst(buffer, "^bbsdir", ctdl_message_dir);
787 typedef const char *ccharp;
789 * display system messages or help
791 void cmd_mesg(char *mname)
801 extract_token(buf, mname, 0, '|', sizeof buf);
803 dirs[0] = strdup(ctdl_message_dir);
804 dirs[1] = strdup(ctdl_hlp_dir);
806 snprintf(buf2, sizeof buf2, "%s.%d.%d",
807 buf, CC->cs_clientdev, CC->cs_clienttyp);
809 /* If the client requested "?" then produce a listing */
810 if (!strcmp(buf, "?")) {
811 cprintf("%d %s\n", LISTING_FOLLOWS, buf);
812 dp = opendir(dirs[1]);
814 while (d = readdir(dp), d != NULL) {
815 if (d->d_name[0] != '.') {
816 cprintf(" %s\n", d->d_name);
827 /* Otherwise, look for the requested file by name. */
829 mesg_locate(targ, sizeof targ, buf2, 2, (const ccharp*)dirs);
830 if (IsEmptyStr(targ)) {
831 snprintf(buf2, sizeof buf2, "%s.%d",
832 buf, CC->cs_clientdev);
833 mesg_locate(targ, sizeof targ, buf2, 2,
834 (const ccharp*)dirs);
835 if (IsEmptyStr(targ)) {
836 mesg_locate(targ, sizeof targ, buf, 2,
837 (const ccharp*)dirs);
845 if (IsEmptyStr(targ)) {
846 cprintf("%d '%s' not found. (Searching in %s and %s)\n",
847 ERROR + FILE_NOT_FOUND,
855 mfp = fopen(targ, "r");
857 cprintf("%d Cannot open '%s': %s\n",
858 ERROR + INTERNAL_ERROR, targ, strerror(errno));
861 cprintf("%d %s\n", LISTING_FOLLOWS,buf);
863 while (fgets(buf, (sizeof buf - 1), mfp) != NULL) {
864 buf[strlen(buf)-1] = 0;
875 * enter system messages or help
877 void cmd_emsg(char *mname)
887 if (CtdlAccessCheck(ac_aide)) return;
889 extract_token(buf, mname, 0, '|', sizeof buf);
890 for (a=0; !IsEmptyStr(&buf[a]); ++a) { /* security measure */
891 if (buf[a] == '/') buf[a] = '.';
894 dirs[0] = strdup(ctdl_message_dir);
895 dirs[1] = strdup(ctdl_hlp_dir);
897 mesg_locate(targ, sizeof targ, buf, 2, (const ccharp*)dirs);
901 if (IsEmptyStr(targ)) {
902 snprintf(targ, sizeof targ,
907 mfp = fopen(targ,"w");
909 cprintf("%d Cannot open '%s': %s\n",
910 ERROR + INTERNAL_ERROR, targ, strerror(errno));
913 cprintf("%d %s\n", SEND_LISTING, targ);
915 while (client_getln(buf, sizeof buf) >=0 && strcmp(buf, "000")) {
916 fprintf(mfp, "%s\n", buf);
922 /*****************************************************************************/
923 /* MODULE INITIALIZATION STUFF */
924 /*****************************************************************************/
926 CTDL_MODULE_INIT(file_ops)
929 CtdlRegisterSessionHook(files_logout_hook, EVT_LOGOUT, PRIO_LOGOUT + 8);
931 CtdlRegisterProtoHook(cmd_delf, "DELF", "Delete a file");
932 CtdlRegisterProtoHook(cmd_movf, "MOVF", "Move a file");
933 CtdlRegisterProtoHook(cmd_open, "OPEN", "Open a download file transfer");
934 CtdlRegisterProtoHook(cmd_clos, "CLOS", "Close a download file transfer");
935 CtdlRegisterProtoHook(cmd_uopn, "UOPN", "Open an upload file transfer");
936 CtdlRegisterProtoHook(cmd_ucls, "UCLS", "Close an upload file transfer");
937 CtdlRegisterProtoHook(cmd_read, "READ", "File transfer read operation");
938 CtdlRegisterProtoHook(cmd_writ, "WRIT", "File transfer write operation");
939 CtdlRegisterProtoHook(cmd_ndop, "NDOP", "Open a network spool file for download");
940 CtdlRegisterProtoHook(cmd_nuop, "NUOP", "Open a network spool file for upload");
941 CtdlRegisterProtoHook(cmd_oimg, "OIMG", "Open an image file for download");
942 CtdlRegisterProtoHook(cmd_uimg, "UIMG", "Upload an image file");
944 CtdlRegisterProtoHook(cmd_mesg, "MESG", "fetch system banners");
945 CtdlRegisterProtoHook(cmd_emsg, "EMSG", "submit system banners");
947 /* return our Subversion id for the Log */