trunk/src/gcvote.c

/*
 * This file is part of GPXView.
 *
 * GPXView is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * GPXView 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GPXView.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <curl/curl.h>
#include <curl/types.h>
#include <curl/easy.h>

#include <libxml/parser.h>
#include <libxml/tree.h>

#include <glib/gstdio.h>

#include <fcntl.h>

#ifndef LIBXML_TREE_ENABLED
#error "Tree not enabled in libxml"
#endif

#include "gpxview.h"

#define ID_PATTERN  "guid="

static size_t mem_write(void *ptr, size_t size, size_t nmemb,
                        void *stream) {
  curl_mem_t *p = (curl_mem_t*)stream;

  p->ptr = g_realloc(p->ptr, p->len + size*nmemb + 1);
  if(p->ptr) {
    memcpy(p->ptr+p->len, ptr, size*nmemb);
    p->len += size*nmemb;
    p->ptr[p->len] = 0;
  }
  return nmemb;
}

/* return list of all votes in this file */
static gcvote_t *votes_parse(xmlDocPtr doc, xmlNode *a_node) {
  xmlNode *cur_node = NULL;

  gcvote_t *votes = NULL, **cur = &votes;

  for (cur_node = a_node->children; cur_node; cur_node = cur_node->next) {
    if (cur_node->type == XML_ELEMENT_NODE) {

      if(strcasecmp((char*)cur_node->name, "vote") == 0) {
        *cur = g_new0(gcvote_t, 1);
        (*cur)->quality = GCVOTE_NONE;

        /* unhandled attributes: */
        /* userName, voteAvg, voteUser, waypoint, vote1-5 */

        /* parse votes attributes */
        char *prop_str = (char*)xmlGetProp(cur_node, BAD_CAST "voteMedian");
        if(prop_str) { 
          (*cur)->quality = atoi(prop_str);
          xmlFree(prop_str);
        }

        prop_str = (char*)xmlGetProp(cur_node, BAD_CAST "voteCnt");
        if(prop_str) {
          (*cur)->votes = atoi(prop_str);
          xmlFree(prop_str);
        }

        prop_str = (char*)xmlGetProp(cur_node, BAD_CAST "cacheId");
        if(prop_str) {
          (*cur)->id = g_strdup(prop_str);
          xmlFree(prop_str);
        }

        cur = &(*cur)->next;
      } else if(strcasecmp((char*)cur_node->name, "errorstring") == 0) {
        /* ignore for now ... */
      } else 
        printf("found unhandled votes/%s\n", cur_node->name);
    }
  } 
  return votes;
}

/* parse root element */
static gcvote_t *parse_root(xmlDocPtr doc, xmlNode *a_node) {
  xmlNode *cur_node = NULL;
  gcvote_t *votes = NULL;

  for (cur_node = a_node; cur_node; cur_node = cur_node->next) {
    if (cur_node->type == XML_ELEMENT_NODE) {

      if(strcasecmp((char*)cur_node->name, "votes") == 0) {
        if(!votes)
          votes = votes_parse(doc, cur_node);
        else
          printf("gcvote: ignoring multiple votes lists\n");
      } else 
        printf("found unhandled %s\n", cur_node->name);
    }
  }
  return votes;
}

static gcvote_t *parse_doc(xmlDocPtr doc) {
  /* Get the root element node */
  xmlNode *root_element = xmlDocGetRootElement(doc);
  gcvote_t *votes = parse_root(doc, root_element);  

  /*free the document */
  xmlFreeDoc(doc);

  /*
   * Free the global variables that may
   * have been allocated by the parser.
   */
  xmlCleanupParser();

  return votes;
}

static void curl_set_proxy(CURL *curl, proxy_t *proxy) {
  if(proxy) {
    if(proxy->ignore_hosts)
      printf("WARNING: Proxy \"ignore_hosts\" unsupported!\n");

    printf("gcvote: using proxy %s:%d\n", proxy->host, proxy->port);

    curl_easy_setopt(curl, CURLOPT_PROXY, proxy->host);
    curl_easy_setopt(curl, CURLOPT_PROXYPORT, proxy->port);

    if(proxy->use_authentication) {
      printf("gcvote:   use auth for user %s\n", proxy->authentication_user);

      char *cred = g_strdup_printf("%s:%s",
                                   proxy->authentication_user,
                                   proxy->authentication_password);

      curl_easy_setopt(curl, CURLOPT_PROXYUSERPWD, cred);
      g_free(cred);
    }
  }
}

void gcvote_request_free(gcvote_request_t *request) {
  /* decrease refcount and only free structure if no references are left */
  request->refcount--;
  if(request->refcount) {
    printf("gcvote: still %d references, keeping request\n", 
           request->refcount);
    return;
  }

  printf("gcvote: no references left, freeing request\n");
  if(request->url)  g_free(request->url);

  if(request->mem.ptr)
    g_free(request->mem.ptr);

  g_free(request);
}

/* gcvote net result handler */
static gboolean gcvote_result_handler(gpointer data) {
  gcvote_request_t *request = (gcvote_request_t*)data;

  printf("gcvote: result handler\n");

  /* worker thread has already reduced its refcounter */
  if(request->refcount < 1) {
    printf("gcvote: main app isn't listening anymore\n");
    return FALSE;
  }

  if(request->res) {
    printf("gcvote: curl failed\n");
    request->cb(NULL, request->userdata);
    return FALSE;
  }

  /* parse the reply */
  /* nothing could be parsed, just give up */
  if(!request->mem.ptr || !request->mem.len) { 
    printf("gcvote: ignoring zero length reply\n");
    request->cb(NULL, request->userdata);
    return FALSE;
  }

  /* start XML parser */
  LIBXML_TEST_VERSION;

  /* parse the file and get the DOM */
  xmlDoc *doc = xmlReadMemory(request->mem.ptr, request->mem.len, 
                              NULL, NULL, 0);

  /* nothing could be parsed, just give up */
  if(!doc) { 
    request->cb(NULL, request->userdata);
    return FALSE;
  }

  vote_t *vote = NULL;
  gcvote_t *votes = parse_doc(doc);
  
  /* search for requested cache in reply and free chain */
  while(votes) {
    gcvote_t *next = votes->next;

    if(!vote && !strcmp(votes->id, request->id) && (votes->quality > 0)) {

      vote = g_new0(vote_t, 1);
      vote->quality = votes->quality;
      vote->votes = votes->votes;
    }

    if(votes->id) g_free(votes->id);
    g_free(votes);
    votes = next;
  }

  if(vote) {
    printf("gcvote: worker found vote %d/%d\n", vote->quality, vote->votes);
    request->cb(vote, request->userdata);
  } else
    printf("gcvote: no vote found\n");

  return FALSE;
}

void gcvote_save(appdata_t *appdata, cache_t *cache, curl_mem_t *mem) {
  if(!mem->len || !mem->ptr) return;

  /* save data to disk */
  char *filename = g_strdup_printf("%s%s/gcvote.xml",
                                   appdata->image_path,
                                   cache->id);
  if(checkdir(filename) != 0) 
    printf("gcvote: unable to create file path\n");
  else {
    printf("gcvote: write %d bytes to %s\n", mem->len, filename);

    int handle = g_open(filename, O_WRONLY | O_CREAT, 0644);
    if(handle >= 0) {
      int len = write(handle, mem->ptr, mem->len);
      close(handle);
      
      /* if write failed, then remove the file */
      if(len != mem->len) 
        g_remove(filename);
    }
  }

  free(filename);
}

static void *worker_thread(void *ptr) {
  gcvote_request_t *request = (gcvote_request_t*)ptr;
  struct curl_httppost *formpost=NULL;
  struct curl_httppost *lastptr=NULL;
  
  printf("gcvote: worker thread running\n");

  request->mem.ptr = NULL;
  request->mem.len = 0;

  printf("gcvote: request to get votes for id %s\n", request->id);

  curl_formadd(&formpost, &lastptr,
               CURLFORM_COPYNAME, "version",
               CURLFORM_COPYCONTENTS, APP VERSION,
               CURLFORM_END);
  
  curl_formadd(&formpost, &lastptr,
               CURLFORM_COPYNAME, "cacheIds",
               CURLFORM_COPYCONTENTS, request->id,
               CURLFORM_END);
  
  /* try to init curl */
  CURL *curl = curl_easy_init();
  if(!curl) {
    curl_formfree(formpost);
    gcvote_request_free(request);

    /* callback anyway, so main loop can also clean up */
    g_idle_add(gcvote_result_handler, request); 
  
    return NULL;
  }
  
  curl_set_proxy(curl, request->proxy);
  
  /* play nice and report some user agent */
  curl_easy_setopt(curl, CURLOPT_USERAGENT, APP " " VERSION);
  
  /* download to memory */
  curl_easy_setopt(curl, CURLOPT_WRITEDATA, &request->mem);
  curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, mem_write);
  
  /* what URL that receives this POST */ 
  curl_easy_setopt(curl, CURLOPT_URL, 
                   "http://dosensuche.de/GCVote/getVotes.php");
  curl_easy_setopt(curl, CURLOPT_HTTPPOST, formpost);
  
  request->res = curl_easy_perform(curl);
  printf("gcvote: curl perform returned with %d\n", request->res);
  
  //  printf("received %d bytes\n", mem.len);
  //  printf("data: %s\n", mem.ptr);
  
  /* always cleanup */ 
  curl_easy_cleanup(curl);
  
  curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &request->response);
  
  /* then cleanup the formpost chain */ 
  curl_formfree(formpost);
  
  printf("gcvote: worker thread done\n");
  gcvote_request_free(request);

  /* cause gtk main loop to handle result */
  g_idle_add(gcvote_result_handler, request); 
  
  printf("gcvote: thread terminating\n");
  
  return NULL;
}

gcvote_request_t *gcvote_request(appdata_t *appdata, gcvote_cb cb, 
                               char *url, gpointer data) {
  if(!url) return NULL;
  
  /* ------ prepare request for worker thread --------- */
  gcvote_request_t *request = g_new0(gcvote_request_t, 1);
  request->url = g_strdup(url);
  request->id = strstr(request->url, ID_PATTERN);
  if(!request->id) {
    printf("gcvote: unable to find id\n");
    gcvote_request_free(request);
    return NULL;
  }
  
  request->id += strlen(ID_PATTERN);
  request->refcount = 2;   // master and worker hold a reference
  request->cb = cb;
  request->userdata = data;

  if(!g_thread_create(&worker_thread, request, FALSE, NULL) != 0) {
    g_warning("gcvote: failed to create the worker thread");

    /* free request and return error */
    request->refcount--;    /* decrease by one for dead worker thread */
    gcvote_request_free(request);
    return NULL;
  }

  return request;
}

1	harbaum	157	/*
2			* This file is part of GPXView.
3			*
4			* GPXView is free software: you can redistribute it and/or modify
5			* it under the terms of the GNU General Public License as published by
6			* the Free Software Foundation, either version 3 of the License, or
7			* (at your option) any later version.
8			*
9			* GPXView 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.
13			*
14			* You should have received a copy of the GNU General Public License
15			* along with GPXView. If not, see <http://www.gnu.org/licenses/>.
16			*/
17	harbaum	152
18	harbaum	157	#include <curl/curl.h>
19			#include <curl/types.h>
20			#include <curl/easy.h>
21
22			#include <libxml/parser.h>
23			#include <libxml/tree.h>
24
25	harbaum	159	#include <glib/gstdio.h>
26
27			#include <fcntl.h>
28
29	harbaum	157	#ifndef LIBXML_TREE_ENABLED
30			#error "Tree not enabled in libxml"
31			#endif
32
33			#include "gpxview.h"
34
35			#define ID_PATTERN "guid="
36
37			static size_t mem_write(void *ptr, size_t size, size_t nmemb,
38			void *stream) {
39			curl_mem_t p = (curl_mem_t)stream;
40
41			p->ptr = g_realloc(p->ptr, p->len + size*nmemb + 1);
42			if(p->ptr) {
43			memcpy(p->ptr+p->len, ptr, size*nmemb);
44			p->len += size*nmemb;
45			p->ptr[p->len] = 0;
46			}
47			return nmemb;
48			}
49
50	harbaum	158	/* return list of all votes in this file */
51			static gcvote_t votes_parse(xmlDocPtr doc, xmlNode a_node) {
52			xmlNode *cur_node = NULL;
53	harbaum	157
54	harbaum	158	gcvote_t votes = NULL, *cur = &votes;
55	harbaum	157
56	harbaum	158	for (cur_node = a_node->children; cur_node; cur_node = cur_node->next) {
57			if (cur_node->type == XML_ELEMENT_NODE) {
58	harbaum	157
59	harbaum	158	if(strcasecmp((char*)cur_node->name, "vote") == 0) {
60			*cur = g_new0(gcvote_t, 1);
61			(*cur)->quality = GCVOTE_NONE;
62	harbaum	157
63	harbaum	158	/* unhandled attributes: */
64			/* userName, voteAvg, voteUser, waypoint, vote1-5 */
65	harbaum	157
66	harbaum	158	/* parse votes attributes */
67			char prop_str = (char)xmlGetProp(cur_node, BAD_CAST "voteMedian");
68			if(prop_str) {
69			(*cur)->quality = atoi(prop_str);
70			xmlFree(prop_str);
71			}
72	harbaum	157
73	harbaum	158	prop_str = (char*)xmlGetProp(cur_node, BAD_CAST "voteCnt");
74			if(prop_str) {
75			(*cur)->votes = atoi(prop_str);
76			xmlFree(prop_str);
77			}
78	harbaum	157
79	harbaum	158	prop_str = (char*)xmlGetProp(cur_node, BAD_CAST "cacheId");
80			if(prop_str) {
81			(*cur)->id = g_strdup(prop_str);
82			xmlFree(prop_str);
83			}
84	harbaum	157
85	harbaum	158	cur = &(*cur)->next;
86			} else if(strcasecmp((char*)cur_node->name, "errorstring") == 0) {
87			/* ignore for now ... */
88			} else
89			printf("found unhandled votes/%s\n", cur_node->name);
90	harbaum	157	}
91	harbaum	158	}
92			return votes;
93	harbaum	157	}
94
95			/* parse root element */
96	harbaum	158	static gcvote_t parse_root(xmlDocPtr doc, xmlNode a_node) {
97	harbaum	157	xmlNode *cur_node = NULL;
98	harbaum	158	gcvote_t *votes = NULL;
99	harbaum	157
100			for (cur_node = a_node; cur_node; cur_node = cur_node->next) {
101			if (cur_node->type == XML_ELEMENT_NODE) {
102
103	harbaum	158	if(strcasecmp((char*)cur_node->name, "votes") == 0) {
104			if(!votes)
105			votes = votes_parse(doc, cur_node);
106			else
107			printf("gcvote: ignoring multiple votes lists\n");
108	harbaum	157	} else
109			printf("found unhandled %s\n", cur_node->name);
110			}
111			}
112	harbaum	158	return votes;
113	harbaum	157	}
114
115	harbaum	158	static gcvote_t *parse_doc(xmlDocPtr doc) {
116	harbaum	157	/* Get the root element node */
117			xmlNode *root_element = xmlDocGetRootElement(doc);
118	harbaum	158	gcvote_t *votes = parse_root(doc, root_element);
119	harbaum	157
120			/free the document /
121			xmlFreeDoc(doc);
122
123			/*
124			* Free the global variables that may
125			* have been allocated by the parser.
126			*/
127			xmlCleanupParser();
128	harbaum	158
129			return votes;
130	harbaum	157	}
131
132	harbaum	158	static void curl_set_proxy(CURL curl, proxy_t proxy) {
133			if(proxy) {
134			if(proxy->ignore_hosts)
135			printf("WARNING: Proxy \"ignore_hosts\" unsupported!\n");
136	harbaum	157
137	harbaum	158	printf("gcvote: using proxy %s:%d\n", proxy->host, proxy->port);
138	harbaum	157
139	harbaum	158	curl_easy_setopt(curl, CURLOPT_PROXY, proxy->host);
140			curl_easy_setopt(curl, CURLOPT_PROXYPORT, proxy->port);
141	harbaum	157
142	harbaum	158	if(proxy->use_authentication) {
143			printf("gcvote: use auth for user %s\n", proxy->authentication_user);
144	harbaum	157
145	harbaum	158	char *cred = g_strdup_printf("%s:%s",
146			proxy->authentication_user,
147			proxy->authentication_password);
148	harbaum	157
149	harbaum	158	curl_easy_setopt(curl, CURLOPT_PROXYUSERPWD, cred);
150			g_free(cred);
151			}
152			}
153			}
154	harbaum	157
155	harbaum	158	void gcvote_request_free(gcvote_request_t *request) {
156			/* decrease refcount and only free structure if no references are left */
157			request->refcount--;
158			if(request->refcount) {
159			printf("gcvote: still %d references, keeping request\n",
160			request->refcount);
161			return;
162			}
163
164			printf("gcvote: no references left, freeing request\n");
165			if(request->url) g_free(request->url);
166
167	harbaum	159	if(request->mem.ptr)
168			g_free(request->mem.ptr);
169
170	harbaum	158	g_free(request);
171			}
172
173			/* gcvote net result handler */
174			static gboolean gcvote_result_handler(gpointer data) {
175			gcvote_request_t request = (gcvote_request_t)data;
176
177			printf("gcvote: result handler\n");
178
179			/* worker thread has already reduced its refcounter */
180			if(request->refcount < 1) {
181			printf("gcvote: main app isn't listening anymore\n");
182			return FALSE;
183			}
184
185			if(request->res) {
186			printf("gcvote: curl failed\n");
187			request->cb(NULL, request->userdata);
188			return FALSE;
189			}
190
191			/* parse the reply */
192			/* nothing could be parsed, just give up */
193			if(!request->mem.ptr \|\| !request->mem.len) {
194			printf("gcvote: ignoring zero length reply\n");
195			request->cb(NULL, request->userdata);
196			return FALSE;
197			}
198
199			/* start XML parser */
200			LIBXML_TEST_VERSION;
201
202			/* parse the file and get the DOM */
203			xmlDoc *doc = xmlReadMemory(request->mem.ptr, request->mem.len,
204			NULL, NULL, 0);
205
206			/* nothing could be parsed, just give up */
207			if(!doc) {
208			request->cb(NULL, request->userdata);
209			return FALSE;
210			}
211
212			vote_t *vote = NULL;
213			gcvote_t *votes = parse_doc(doc);
214
215			/* search for requested cache in reply and free chain */
216			while(votes) {
217			gcvote_t *next = votes->next;
218
219			if(!vote && !strcmp(votes->id, request->id) && (votes->quality > 0)) {
220
221			vote = g_new0(vote_t, 1);
222			vote->quality = votes->quality;
223			vote->votes = votes->votes;
224			}
225
226			if(votes->id) g_free(votes->id);
227			g_free(votes);
228			votes = next;
229			}
230
231			if(vote) {
232			printf("gcvote: worker found vote %d/%d\n", vote->quality, vote->votes);
233			request->cb(vote, request->userdata);
234			} else
235			printf("gcvote: no vote found\n");
236
237			return FALSE;
238			}
239
240	harbaum	159	void gcvote_save(appdata_t appdata, cache_t cache, curl_mem_t *mem) {
241			if(!mem->len \|\| !mem->ptr) return;
242
243			/* save data to disk */
244			char *filename = g_strdup_printf("%s%s/gcvote.xml",
245			appdata->image_path,
246			cache->id);
247			if(checkdir(filename) != 0)
248			printf("gcvote: unable to create file path\n");
249			else {
250			printf("gcvote: write %d bytes to %s\n", mem->len, filename);
251
252			int handle = g_open(filename, O_WRONLY \| O_CREAT, 0644);
253			if(handle >= 0) {
254			int len = write(handle, mem->ptr, mem->len);
255			close(handle);
256
257			/* if write failed, then remove the file */
258			if(len != mem->len)
259			g_remove(filename);
260			}
261			}
262
263			free(filename);
264			}
265
266	harbaum	158	static void worker_thread(void ptr) {
267			gcvote_request_t request = (gcvote_request_t)ptr;
268			struct curl_httppost *formpost=NULL;
269			struct curl_httppost *lastptr=NULL;
270
271			printf("gcvote: worker thread running\n");
272
273			request->mem.ptr = NULL;
274			request->mem.len = 0;
275
276			printf("gcvote: request to get votes for id %s\n", request->id);
277
278	harbaum	157	curl_formadd(&formpost, &lastptr,
279	harbaum	158	CURLFORM_COPYNAME, "version",
280			CURLFORM_COPYCONTENTS, APP VERSION,
281			CURLFORM_END);
282	harbaum	157
283			curl_formadd(&formpost, &lastptr,
284	harbaum	158	CURLFORM_COPYNAME, "cacheIds",
285			CURLFORM_COPYCONTENTS, request->id,
286			CURLFORM_END);
287
288			/* try to init curl */
289			CURL *curl = curl_easy_init();
290			if(!curl) {
291			curl_formfree(formpost);
292			gcvote_request_free(request);
293	harbaum	157
294	harbaum	158	/* callback anyway, so main loop can also clean up */
295			g_idle_add(gcvote_result_handler, request);
296
297			return NULL;
298			}
299
300			curl_set_proxy(curl, request->proxy);
301
302	harbaum	157	/* play nice and report some user agent */
303			curl_easy_setopt(curl, CURLOPT_USERAGENT, APP " " VERSION);
304	harbaum	158
305	harbaum	157	/* download to memory */
306	harbaum	158	curl_easy_setopt(curl, CURLOPT_WRITEDATA, &request->mem);
307	harbaum	157	curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, mem_write);
308
309			/* what URL that receives this POST */
310	harbaum	158	curl_easy_setopt(curl, CURLOPT_URL,
311			"http://dosensuche.de/GCVote/getVotes.php");
312	harbaum	157	curl_easy_setopt(curl, CURLOPT_HTTPPOST, formpost);
313
314	harbaum	158	request->res = curl_easy_perform(curl);
315			printf("gcvote: curl perform returned with %d\n", request->res);
316
317			// printf("received %d bytes\n", mem.len);
318			// printf("data: %s\n", mem.ptr);
319
320	harbaum	157	/* always cleanup */
321			curl_easy_cleanup(curl);
322
323	harbaum	158	curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &request->response);
324
325	harbaum	157	/* then cleanup the formpost chain */
326			curl_formfree(formpost);
327	harbaum	158
328			printf("gcvote: worker thread done\n");
329			gcvote_request_free(request);
330	harbaum	159
331	harbaum	158	/* cause gtk main loop to handle result */
332			g_idle_add(gcvote_result_handler, request);
333
334			printf("gcvote: thread terminating\n");
335
336			return NULL;
337			}
338	harbaum	157
339	harbaum	158	gcvote_request_t gcvote_request(appdata_t appdata, gcvote_cb cb,
340			char *url, gpointer data) {
341			if(!url) return NULL;
342
343			/* ------ prepare request for worker thread --------- */
344			gcvote_request_t *request = g_new0(gcvote_request_t, 1);
345			request->url = g_strdup(url);
346			request->id = strstr(request->url, ID_PATTERN);
347			if(!request->id) {
348			printf("gcvote: unable to find id\n");
349			gcvote_request_free(request);
350			return NULL;
351			}
352
353			request->id += strlen(ID_PATTERN);
354			request->refcount = 2; // master and worker hold a reference
355			request->cb = cb;
356			request->userdata = data;
357	harbaum	157
358	harbaum	158	if(!g_thread_create(&worker_thread, request, FALSE, NULL) != 0) {
359			g_warning("gcvote: failed to create the worker thread");
360
361			/* free request and return error */
362			request->refcount--; /* decrease by one for dead worker thread */
363			gcvote_request_free(request);
364			return NULL;
365	harbaum	157	}
366
367	harbaum	158	return request;
368			}
369	harbaum	157