1 /***************************************************************************
2  *                                  _   _ ____  _
3  *  Project                     ___| | | |  _ \| |
4  *                             / __| | | | |_) | |
5  *                            | (__| |_| |  _ <| |___
6  *                             \___|\___/|_| \_\_____|
7  *
8  * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
9  *
10  * This software is licensed as described in the file COPYING, which
11  * you should have received as part of this distribution. The terms
12  * are also available at http://curl.haxx.se/docs/copyright.html.
13  *
14  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15  * copies of the Software, and permit persons to whom the Software is
16  * furnished to do so, under the terms of the COPYING file.
17  *
18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19  * KIND, either express or implied.
20  *
21  ***************************************************************************/
22 
23 #include "curl_setup.h"
24 
25 #ifndef CURL_DISABLE_GOPHER
26 
27 #include "urldata.h"
28 #include <curl/curl.h>
29 #include "transfer.h"
30 #include "sendf.h"
31 
32 #include "progress.h"
33 #include "strequal.h"
34 #include "gopher.h"
35 #include "rawstr.h"
36 #include "select.h"
37 #include "url.h"
38 #include "warnless.h"
39 #include "curl_memory.h"
40 /* The last #include file should be: */
41 #include "memdebug.h"
42 
43 /*
44  * Forward declarations.
45  */
46 
47 static CURLcode gopher_do(struct connectdata *conn, bool *done);
48 
49 /*
50  * Gopher protocol handler.
51  * This is also a nice simple template to build off for simple
52  * connect-command-download protocols.
53  */
54 
55 const struct Curl_handler Curl_handler_gopher = {
56   "GOPHER",                             /* scheme */
57   ZERO_NULL,                            /* setup_connection */
58   gopher_do,                            /* do_it */
59   ZERO_NULL,                            /* done */
60   ZERO_NULL,                            /* do_more */
61   ZERO_NULL,                            /* connect_it */
62   ZERO_NULL,                            /* connecting */
63   ZERO_NULL,                            /* doing */
64   ZERO_NULL,                            /* proto_getsock */
65   ZERO_NULL,                            /* doing_getsock */
66   ZERO_NULL,                            /* domore_getsock */
67   ZERO_NULL,                            /* perform_getsock */
68   ZERO_NULL,                            /* disconnect */
69   ZERO_NULL,                            /* readwrite */
70   PORT_GOPHER,                          /* defport */
71   CURLPROTO_GOPHER,                     /* protocol */
72   PROTOPT_NONE                          /* flags */
73 };
74 
gopher_do(struct connectdata * conn,bool * done)75 static CURLcode gopher_do(struct connectdata *conn, bool *done)
76 {
77   CURLcode result=CURLE_OK;
78   struct SessionHandle *data=conn->data;
79   curl_socket_t sockfd = conn->sock[FIRSTSOCKET];
80 
81   curl_off_t *bytecount = &data->req.bytecount;
82   char *path = data->state.path;
83   char *sel;
84   char *sel_org = NULL;
85   ssize_t amount, k;
86 
87   *done = TRUE; /* unconditionally */
88 
89   /* Create selector. Degenerate cases: / and /1 => convert to "" */
90   if(strlen(path) <= 2)
91     sel = (char *)"";
92   else {
93     char *newp;
94     size_t j, i;
95     int len;
96 
97     /* Otherwise, drop / and the first character (i.e., item type) ... */
98     newp = path;
99     newp+=2;
100 
101     /* ... then turn ? into TAB for search servers, Veronica, etc. ... */
102     j = strlen(newp);
103     for(i=0; i<j; i++)
104       if(newp[i] == '?')
105         newp[i] = '\x09';
106 
107     /* ... and finally unescape */
108     sel = curl_easy_unescape(data, newp, 0, &len);
109     if(!sel)
110       return CURLE_OUT_OF_MEMORY;
111     sel_org = sel;
112   }
113 
114   /* We use Curl_write instead of Curl_sendf to make sure the entire buffer is
115      sent, which could be sizeable with long selectors. */
116   k = curlx_uztosz(strlen(sel));
117 
118   for(;;) {
119     result = Curl_write(conn, sockfd, sel, k, &amount);
120     if(!result) { /* Which may not have written it all! */
121       result = Curl_client_write(conn, CLIENTWRITE_HEADER, sel, amount);
122       if(result) {
123         free(sel_org);
124         return result;
125       }
126       k -= amount;
127       sel += amount;
128       if(k < 1)
129         break; /* but it did write it all */
130     }
131     else {
132       failf(data, "Failed sending Gopher request");
133       free(sel_org);
134       return result;
135     }
136     /* Don't busyloop. The entire loop thing is a work-around as it causes a
137        BLOCKING behavior which is a NO-NO. This function should rather be
138        split up in a do and a doing piece where the pieces that aren't
139        possible to send now will be sent in the doing function repeatedly
140        until the entire request is sent.
141 
142        Wait a while for the socket to be writable. Note that this doesn't
143        acknowledge the timeout.
144     */
145     Curl_socket_ready(CURL_SOCKET_BAD, sockfd, 100);
146   }
147 
148   free(sel_org);
149 
150   /* We can use Curl_sendf to send the terminal \r\n relatively safely and
151      save allocing another string/doing another _write loop. */
152   result = Curl_sendf(sockfd, conn, "\r\n");
153   if(result) {
154     failf(data, "Failed sending Gopher request");
155     return result;
156   }
157   result = Curl_client_write(conn, CLIENTWRITE_HEADER, (char *)"\r\n", 2);
158   if(result)
159     return result;
160 
161   Curl_setup_transfer(conn, FIRSTSOCKET, -1, FALSE, bytecount,
162                       -1, NULL); /* no upload */
163   return CURLE_OK;
164 }
165 #endif /*CURL_DISABLE_GOPHER*/
166