llcurl.cpp
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:23k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /**
  2.  * @file llcurl.h
  3.  * @author Zero / Donovan
  4.  * @date 2006-10-15
  5.  * @brief Implementation of wrapper around libcurl.
  6.  *
  7.  * $LicenseInfo:firstyear=2006&license=viewergpl$
  8.  * 
  9.  * Copyright (c) 2006-2010, Linden Research, Inc.
  10.  * 
  11.  * Second Life Viewer Source Code
  12.  * The source code in this file ("Source Code") is provided by Linden Lab
  13.  * to you under the terms of the GNU General Public License, version 2.0
  14.  * ("GPL"), unless you have obtained a separate licensing agreement
  15.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  16.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  17.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  18.  * 
  19.  * There are special exceptions to the terms and conditions of the GPL as
  20.  * it is applied to this Source Code. View the full text of the exception
  21.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  22.  * online at
  23.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  24.  * 
  25.  * By copying, modifying or distributing this software, you acknowledge
  26.  * that you have read and understood your obligations described above,
  27.  * and agree to abide by those obligations.
  28.  * 
  29.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  30.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  31.  * COMPLETENESS OR PERFORMANCE.
  32.  * $/LicenseInfo$
  33.  */
  34. #if LL_WINDOWS
  35. #define SAFE_SSL 1
  36. #elif LL_DARWIN
  37. #define SAFE_SSL 1
  38. #else
  39. #define SAFE_SSL 1
  40. #endif
  41. #include "linden_common.h"
  42. #include "llcurl.h"
  43. #include <algorithm>
  44. #include <iomanip>
  45. #include <curl/curl.h>
  46. #if SAFE_SSL
  47. #include <openssl/crypto.h>
  48. #endif
  49. #include "llbufferstream.h"
  50. #include "llstl.h"
  51. #include "llsdserialize.h"
  52. #include "llthread.h"
  53. //////////////////////////////////////////////////////////////////////////////
  54. /*
  55. The trick to getting curl to do keep-alives is to reuse the
  56. same easy handle for the requests.  It appears that curl
  57. keeps a pool of connections alive for each easy handle, but
  58. doesn't share them between easy handles.  Therefore it is
  59. important to keep a pool of easy handles and reuse them,
  60. rather than create and destroy them with each request.  This
  61. code does this.
  62. Furthermore, it would behoove us to keep track of which
  63. hosts an easy handle was used for and pick an easy handle
  64. that matches the next request.  This code does not current
  65. do this.
  66.  */
  67. //////////////////////////////////////////////////////////////////////////////
  68. static const U32 EASY_HANDLE_POOL_SIZE = 5;
  69. static const S32 MULTI_PERFORM_CALL_REPEAT = 5;
  70. static const S32 CURL_REQUEST_TIMEOUT = 30; // seconds
  71. static const S32 MAX_ACTIVE_REQUEST_COUNT = 100;
  72. // DEBUG //
  73. S32 gCurlEasyCount = 0;
  74. S32 gCurlMultiCount = 0;
  75. //////////////////////////////////////////////////////////////////////////////
  76. //static
  77. std::vector<LLMutex*> LLCurl::sSSLMutex;
  78. std::string LLCurl::sCAPath;
  79. std::string LLCurl::sCAFile;
  80. // Verify SSL certificates by default (matches libcurl default). The ability
  81. // to alter this flag is only to allow us to suppress verification if it's
  82. // broken for some reason.
  83. bool LLCurl::sSSLVerify = true;
  84. //static
  85. void LLCurl::setCAPath(const std::string& path)
  86. {
  87. sCAPath = path;
  88. }
  89. //static
  90. void LLCurl::setCAFile(const std::string& file)
  91. {
  92. sCAFile = file;
  93. }
  94. //static
  95. void LLCurl::setSSLVerify(bool verify)
  96. {
  97. sSSLVerify = verify;
  98. }
  99. //static
  100. bool LLCurl::getSSLVerify()
  101. {
  102. return sSSLVerify;
  103. }
  104. //static
  105. std::string LLCurl::getVersionString()
  106. {
  107. return std::string(curl_version());
  108. }
  109. //////////////////////////////////////////////////////////////////////////////
  110. LLCurl::Responder::Responder()
  111. : mReferenceCount(0)
  112. {
  113. }
  114. LLCurl::Responder::~Responder()
  115. {
  116. }
  117. // virtual
  118. void LLCurl::Responder::errorWithContent(
  119. U32 status,
  120. const std::string& reason,
  121. const LLSD&)
  122. {
  123. error(status, reason);
  124. }
  125. // virtual
  126. void LLCurl::Responder::error(U32 status, const std::string& reason)
  127. {
  128. llinfos << mURL << " [" << status << "]: " << reason << llendl;
  129. }
  130. // virtual
  131. void LLCurl::Responder::result(const LLSD& content)
  132. {
  133. }
  134. void LLCurl::Responder::setURL(const std::string& url)
  135. {
  136. mURL = url;
  137. }
  138. // virtual
  139. void LLCurl::Responder::completedRaw(
  140. U32 status,
  141. const std::string& reason,
  142. const LLChannelDescriptors& channels,
  143. const LLIOPipe::buffer_ptr_t& buffer)
  144. {
  145. LLSD content;
  146. LLBufferStream istr(channels, buffer.get());
  147. if (!LLSDSerialize::fromXML(content, istr))
  148. {
  149. llinfos << "Failed to deserialize LLSD. " << mURL << " [" << status << "]: " << reason << llendl;
  150. }
  151. completed(status, reason, content);
  152. }
  153. // virtual
  154. void LLCurl::Responder::completed(U32 status, const std::string& reason, const LLSD& content)
  155. {
  156. if (isGoodStatus(status))
  157. {
  158. result(content);
  159. }
  160. else
  161. {
  162. errorWithContent(status, reason, content);
  163. }
  164. }
  165. //virtual
  166. void LLCurl::Responder::completedHeader(U32 status, const std::string& reason, const LLSD& content)
  167. {
  168. }
  169. namespace boost
  170. {
  171. void intrusive_ptr_add_ref(LLCurl::Responder* p)
  172. {
  173. ++p->mReferenceCount;
  174. }
  175. void intrusive_ptr_release(LLCurl::Responder* p)
  176. {
  177. if(p && 0 == --p->mReferenceCount)
  178. {
  179. delete p;
  180. }
  181. }
  182. };
  183. //////////////////////////////////////////////////////////////////////////////
  184. class LLCurl::Easy
  185. {
  186. LOG_CLASS(Easy);
  187. private:
  188. Easy();
  189. public:
  190. static Easy* getEasy();
  191. ~Easy();
  192. CURL* getCurlHandle() const { return mCurlEasyHandle; }
  193. void setErrorBuffer();
  194. void setCA();
  195. void setopt(CURLoption option, S32 value);
  196. // These assume the setter does not free value!
  197. void setopt(CURLoption option, void* value);
  198. void setopt(CURLoption option, char* value);
  199. // Copies the string so that it is gauranteed to stick around
  200. void setoptString(CURLoption option, const std::string& value);
  201. void slist_append(const char* str);
  202. void setHeaders();
  203. U32 report(CURLcode);
  204. void getTransferInfo(LLCurl::TransferInfo* info);
  205. void prepRequest(const std::string& url, const std::vector<std::string>& headers, ResponderPtr, bool post = false);
  206. const char* getErrorBuffer();
  207. std::stringstream& getInput() { return mInput; }
  208. std::stringstream& getHeaderOutput() { return mHeaderOutput; }
  209. LLIOPipe::buffer_ptr_t& getOutput() { return mOutput; }
  210. const LLChannelDescriptors& getChannels() { return mChannels; }
  211. void resetState();
  212. private:
  213. CURL* mCurlEasyHandle;
  214. struct curl_slist* mHeaders;
  215. std::stringstream mRequest;
  216. LLChannelDescriptors mChannels;
  217. LLIOPipe::buffer_ptr_t mOutput;
  218. std::stringstream mInput;
  219. std::stringstream mHeaderOutput;
  220. char mErrorBuffer[CURL_ERROR_SIZE];
  221. // Note: char*'s not strings since we pass pointers to curl
  222. std::vector<char*> mStrings;
  223. ResponderPtr mResponder;
  224. };
  225. LLCurl::Easy::Easy()
  226. : mHeaders(NULL),
  227.   mCurlEasyHandle(NULL)
  228. {
  229. mErrorBuffer[0] = 0;
  230. }
  231. LLCurl::Easy* LLCurl::Easy::getEasy()
  232. {
  233. Easy* easy = new Easy();
  234. easy->mCurlEasyHandle = curl_easy_init();
  235. if (!easy->mCurlEasyHandle)
  236. {
  237. // this can happen if we have too many open files (fails in c-ares/ares_init.c)
  238. llwarns << "curl_multi_init() returned NULL! Easy handles: " << gCurlEasyCount << " Multi handles: " << gCurlMultiCount << llendl;
  239. delete easy;
  240. return NULL;
  241. }
  242. // set no DMS caching as default for all easy handles. This prevents them adopting a
  243. // multi handles cache if they are added to one.
  244. curl_easy_setopt(easy->mCurlEasyHandle, CURLOPT_DNS_CACHE_TIMEOUT, 0);
  245. ++gCurlEasyCount;
  246. return easy;
  247. }
  248. LLCurl::Easy::~Easy()
  249. {
  250. curl_easy_cleanup(mCurlEasyHandle);
  251. --gCurlEasyCount;
  252. curl_slist_free_all(mHeaders);
  253. for_each(mStrings.begin(), mStrings.end(), DeletePointerArray());
  254. }
  255. void LLCurl::Easy::resetState()
  256. {
  257.   curl_easy_reset(mCurlEasyHandle);
  258. if (mHeaders)
  259. {
  260. curl_slist_free_all(mHeaders);
  261. mHeaders = NULL;
  262. }
  263. mRequest.str("");
  264. mRequest.clear();
  265. mOutput.reset();
  266. mInput.str("");
  267. mInput.clear();
  268. mErrorBuffer[0] = 0;
  269. mHeaderOutput.str("");
  270. mHeaderOutput.clear();
  271. }
  272. void LLCurl::Easy::setErrorBuffer()
  273. {
  274. setopt(CURLOPT_ERRORBUFFER, &mErrorBuffer);
  275. }
  276. const char* LLCurl::Easy::getErrorBuffer()
  277. {
  278. return mErrorBuffer;
  279. }
  280. void LLCurl::Easy::setCA()
  281. {
  282. if(!sCAPath.empty())
  283. {
  284. setoptString(CURLOPT_CAPATH, sCAPath);
  285. }
  286. if(!sCAFile.empty())
  287. {
  288. setoptString(CURLOPT_CAINFO, sCAFile);
  289. }
  290. }
  291. void LLCurl::Easy::setHeaders()
  292. {
  293. setopt(CURLOPT_HTTPHEADER, mHeaders);
  294. }
  295. void LLCurl::Easy::getTransferInfo(LLCurl::TransferInfo* info)
  296. {
  297. curl_easy_getinfo(mCurlEasyHandle, CURLINFO_SIZE_DOWNLOAD, &info->mSizeDownload);
  298. curl_easy_getinfo(mCurlEasyHandle, CURLINFO_TOTAL_TIME, &info->mTotalTime);
  299. curl_easy_getinfo(mCurlEasyHandle, CURLINFO_SPEED_DOWNLOAD, &info->mSpeedDownload);
  300. }
  301. U32 LLCurl::Easy::report(CURLcode code)
  302. {
  303. U32 responseCode = 0;
  304. std::string responseReason;
  305. if (code == CURLE_OK)
  306. {
  307. curl_easy_getinfo(mCurlEasyHandle, CURLINFO_RESPONSE_CODE, &responseCode);
  308. //*TODO: get reason from first line of mHeaderOutput
  309. }
  310. else
  311. {
  312. responseCode = 499;
  313. responseReason = strerror(code) + " : " + mErrorBuffer;
  314. }
  315. if (mResponder)
  316. {
  317. mResponder->completedRaw(responseCode, responseReason, mChannels, mOutput);
  318. mResponder = NULL;
  319. }
  320. resetState();
  321. return responseCode;
  322. }
  323. // Note: these all assume the caller tracks the value (i.e. keeps it persistant)
  324. void LLCurl::Easy::setopt(CURLoption option, S32 value)
  325. {
  326. curl_easy_setopt(mCurlEasyHandle, option, value);
  327. }
  328. void LLCurl::Easy::setopt(CURLoption option, void* value)
  329. {
  330. curl_easy_setopt(mCurlEasyHandle, option, value);
  331. }
  332. void LLCurl::Easy::setopt(CURLoption option, char* value)
  333. {
  334. curl_easy_setopt(mCurlEasyHandle, option, value);
  335. }
  336. // Note: this copies the string so that the caller does not have to keep it around
  337. void LLCurl::Easy::setoptString(CURLoption option, const std::string& value)
  338. {
  339. char* tstring = new char[value.length()+1];
  340. strcpy(tstring, value.c_str());
  341. mStrings.push_back(tstring);
  342. curl_easy_setopt(mCurlEasyHandle, option, tstring);
  343. }
  344. void LLCurl::Easy::slist_append(const char* str)
  345. {
  346. mHeaders = curl_slist_append(mHeaders, str);
  347. }
  348. size_t curlReadCallback(char* data, size_t size, size_t nmemb, void* user_data)
  349. {
  350. LLCurl::Easy* easy = (LLCurl::Easy*)user_data;
  351. S32 n = size * nmemb;
  352. S32 startpos = easy->getInput().tellg();
  353. easy->getInput().seekg(0, std::ios::end);
  354. S32 endpos = easy->getInput().tellg();
  355. easy->getInput().seekg(startpos, std::ios::beg);
  356. S32 maxn = endpos - startpos;
  357. n = llmin(n, maxn);
  358. easy->getInput().read((char*)data, n);
  359. return n;
  360. }
  361. size_t curlWriteCallback(char* data, size_t size, size_t nmemb, void* user_data)
  362. {
  363. LLCurl::Easy* easy = (LLCurl::Easy*)user_data;
  364. S32 n = size * nmemb;
  365. easy->getOutput()->append(easy->getChannels().in(), (const U8*)data, n);
  366. return n;
  367. }
  368. size_t curlHeaderCallback(void* data, size_t size, size_t nmemb, void* user_data)
  369. {
  370. LLCurl::Easy* easy = (LLCurl::Easy*)user_data;
  371. size_t n = size * nmemb;
  372. easy->getHeaderOutput().write((const char*)data, n);
  373. return n;
  374. }
  375. void LLCurl::Easy::prepRequest(const std::string& url,
  376.    const std::vector<std::string>& headers,
  377.    ResponderPtr responder, bool post)
  378. {
  379. resetState();
  380. if (post) setoptString(CURLOPT_ENCODING, "");
  381. // setopt(CURLOPT_VERBOSE, 1); // usefull for debugging
  382. setopt(CURLOPT_NOSIGNAL, 1);
  383. mOutput.reset(new LLBufferArray);
  384. setopt(CURLOPT_WRITEFUNCTION, (void*)&curlWriteCallback);
  385. setopt(CURLOPT_WRITEDATA, (void*)this);
  386. setopt(CURLOPT_READFUNCTION, (void*)&curlReadCallback);
  387. setopt(CURLOPT_READDATA, (void*)this);
  388. setopt(CURLOPT_HEADERFUNCTION, (void*)&curlHeaderCallback);
  389. setopt(CURLOPT_HEADERDATA, (void*)this);
  390. setErrorBuffer();
  391. setCA();
  392. setopt(CURLOPT_SSL_VERIFYPEER, LLCurl::getSSLVerify());
  393. setopt(CURLOPT_SSL_VERIFYHOST, LLCurl::getSSLVerify()? 2 : 0);
  394. setopt(CURLOPT_TIMEOUT, CURL_REQUEST_TIMEOUT);
  395. setoptString(CURLOPT_URL, url);
  396. mResponder = responder;
  397. if (!post)
  398. {
  399. slist_append("Connection: keep-alive");
  400. slist_append("Keep-alive: 300");
  401. // Accept and other headers
  402. for (std::vector<std::string>::const_iterator iter = headers.begin();
  403.  iter != headers.end(); ++iter)
  404. {
  405. slist_append((*iter).c_str());
  406. }
  407. }
  408. }
  409. ////////////////////////////////////////////////////////////////////////////
  410. class LLCurl::Multi
  411. {
  412. LOG_CLASS(Multi);
  413. public:
  414. Multi();
  415. ~Multi();
  416. Easy* allocEasy();
  417. bool addEasy(Easy* easy);
  418. void removeEasy(Easy* easy);
  419. S32 process();
  420. S32 perform();
  421. CURLMsg* info_read(S32* msgs_in_queue);
  422. S32 mQueued;
  423. S32 mErrorCount;
  424. private:
  425. void easyFree(Easy*);
  426. CURLM* mCurlMultiHandle;
  427. typedef std::set<Easy*> easy_active_list_t;
  428. easy_active_list_t mEasyActiveList;
  429. typedef std::map<CURL*, Easy*> easy_active_map_t;
  430. easy_active_map_t mEasyActiveMap;
  431. typedef std::set<Easy*> easy_free_list_t;
  432. easy_free_list_t mEasyFreeList;
  433. };
  434. LLCurl::Multi::Multi()
  435. : mQueued(0),
  436.   mErrorCount(0)
  437. {
  438. mCurlMultiHandle = curl_multi_init();
  439. if (!mCurlMultiHandle)
  440. {
  441. llwarns << "curl_multi_init() returned NULL! Easy handles: " << gCurlEasyCount << " Multi handles: " << gCurlMultiCount << llendl;
  442. mCurlMultiHandle = curl_multi_init();
  443. }
  444. llassert_always(mCurlMultiHandle);
  445. ++gCurlMultiCount;
  446. }
  447. LLCurl::Multi::~Multi()
  448. {
  449. // Clean up active
  450. for(easy_active_list_t::iterator iter = mEasyActiveList.begin();
  451. iter != mEasyActiveList.end(); ++iter)
  452. {
  453. Easy* easy = *iter;
  454. curl_multi_remove_handle(mCurlMultiHandle, easy->getCurlHandle());
  455. delete easy;
  456. }
  457. mEasyActiveList.clear();
  458. mEasyActiveMap.clear();
  459. // Clean up freed
  460. for_each(mEasyFreeList.begin(), mEasyFreeList.end(), DeletePointer());
  461. mEasyFreeList.clear();
  462. curl_multi_cleanup(mCurlMultiHandle);
  463. --gCurlMultiCount;
  464. }
  465. CURLMsg* LLCurl::Multi::info_read(S32* msgs_in_queue)
  466. {
  467. CURLMsg* curlmsg = curl_multi_info_read(mCurlMultiHandle, msgs_in_queue);
  468. return curlmsg;
  469. }
  470. S32 LLCurl::Multi::perform()
  471. {
  472. S32 q = 0;
  473. for (S32 call_count = 0;
  474.  call_count < MULTI_PERFORM_CALL_REPEAT;
  475.  call_count += 1)
  476. {
  477. CURLMcode code = curl_multi_perform(mCurlMultiHandle, &q);
  478. if (CURLM_CALL_MULTI_PERFORM != code || q == 0)
  479. {
  480. break;
  481. }
  482. }
  483. mQueued = q;
  484. return q;
  485. }
  486. S32 LLCurl::Multi::process()
  487. {
  488. perform();
  489. CURLMsg* msg;
  490. int msgs_in_queue;
  491. S32 processed = 0;
  492. while ((msg = info_read(&msgs_in_queue)))
  493. {
  494. ++processed;
  495. if (msg->msg == CURLMSG_DONE)
  496. {
  497. U32 response = 0;
  498. easy_active_map_t::iterator iter = mEasyActiveMap.find(msg->easy_handle);
  499. if (iter != mEasyActiveMap.end())
  500. {
  501. Easy* easy = iter->second;
  502. response = easy->report(msg->data.result);
  503. removeEasy(easy);
  504. }
  505. else
  506. {
  507. response = 499;
  508. //*TODO: change to llwarns
  509. llerrs << "cleaned up curl request completed!" << llendl;
  510. }
  511. if (response >= 400)
  512. {
  513. // failure of some sort, inc mErrorCount for debugging and flagging multi for destruction
  514. ++mErrorCount;
  515. }
  516. }
  517. }
  518. return processed;
  519. }
  520. LLCurl::Easy* LLCurl::Multi::allocEasy()
  521. {
  522. Easy* easy = 0;
  523. if (mEasyFreeList.empty())
  524. {
  525. easy = Easy::getEasy();
  526. }
  527. else
  528. {
  529. easy = *(mEasyFreeList.begin());
  530. mEasyFreeList.erase(easy);
  531. }
  532. if (easy)
  533. {
  534. mEasyActiveList.insert(easy);
  535. mEasyActiveMap[easy->getCurlHandle()] = easy;
  536. }
  537. return easy;
  538. }
  539. bool LLCurl::Multi::addEasy(Easy* easy)
  540. {
  541. CURLMcode mcode = curl_multi_add_handle(mCurlMultiHandle, easy->getCurlHandle());
  542. if (mcode != CURLM_OK)
  543. {
  544. llwarns << "Curl Error: " << curl_multi_strerror(mcode) << llendl;
  545. return false;
  546. }
  547. return true;
  548. }
  549. void LLCurl::Multi::easyFree(Easy* easy)
  550. {
  551. mEasyActiveList.erase(easy);
  552. mEasyActiveMap.erase(easy->getCurlHandle());
  553. if (mEasyFreeList.size() < EASY_HANDLE_POOL_SIZE)
  554. {
  555. easy->resetState();
  556. mEasyFreeList.insert(easy);
  557. }
  558. else
  559. {
  560. delete easy;
  561. }
  562. }
  563. void LLCurl::Multi::removeEasy(Easy* easy)
  564. {
  565. curl_multi_remove_handle(mCurlMultiHandle, easy->getCurlHandle());
  566. easyFree(easy);
  567. }
  568. //static
  569. std::string LLCurl::strerror(CURLcode errorcode)
  570. {
  571. #if LL_DARWIN
  572. // curl_easy_strerror was added in libcurl 7.12.0.  Unfortunately, the version in the Mac OS X 10.3.9 SDK is 7.10.2...
  573. // There's a problem with the custom curl headers in our build that keeps me from #ifdefing this on the libcurl version number
  574. // (the correct check would be #if LIBCURL_VERSION_NUM >= 0x070c00).  We'll fix the header problem soon, but for now
  575. // just punt and print the numeric error code on the Mac.
  576. return llformat("%d", errorcode);
  577. #else // LL_DARWIN
  578. return std::string(curl_easy_strerror(errorcode));
  579. #endif // LL_DARWIN
  580. }
  581. ////////////////////////////////////////////////////////////////////////////
  582. // For generating a simple request for data
  583. // using one multi and one easy per request 
  584. LLCurlRequest::LLCurlRequest() :
  585. mActiveMulti(NULL),
  586. mActiveRequestCount(0)
  587. {
  588. mThreadID = LLThread::currentID();
  589. }
  590. LLCurlRequest::~LLCurlRequest()
  591. {
  592. llassert_always(mThreadID == LLThread::currentID());
  593. for_each(mMultiSet.begin(), mMultiSet.end(), DeletePointer());
  594. }
  595. void LLCurlRequest::addMulti()
  596. {
  597. llassert_always(mThreadID == LLThread::currentID());
  598. LLCurl::Multi* multi = new LLCurl::Multi();
  599. mMultiSet.insert(multi);
  600. mActiveMulti = multi;
  601. mActiveRequestCount = 0;
  602. }
  603. LLCurl::Easy* LLCurlRequest::allocEasy()
  604. {
  605. if (!mActiveMulti ||
  606. mActiveRequestCount >= MAX_ACTIVE_REQUEST_COUNT ||
  607. mActiveMulti->mErrorCount > 0)
  608. {
  609. addMulti();
  610. }
  611. llassert_always(mActiveMulti);
  612. ++mActiveRequestCount;
  613. LLCurl::Easy* easy = mActiveMulti->allocEasy();
  614. return easy;
  615. }
  616. bool LLCurlRequest::addEasy(LLCurl::Easy* easy)
  617. {
  618. llassert_always(mActiveMulti);
  619. bool res = mActiveMulti->addEasy(easy);
  620. return res;
  621. }
  622. void LLCurlRequest::get(const std::string& url, LLCurl::ResponderPtr responder)
  623. {
  624. getByteRange(url, headers_t(), 0, -1, responder);
  625. }
  626. bool LLCurlRequest::getByteRange(const std::string& url,
  627.  const headers_t& headers,
  628.  S32 offset, S32 length,
  629.  LLCurl::ResponderPtr responder)
  630. {
  631. LLCurl::Easy* easy = allocEasy();
  632. if (!easy)
  633. {
  634. return false;
  635. }
  636. easy->prepRequest(url, headers, responder);
  637. easy->setopt(CURLOPT_HTTPGET, 1);
  638. if (length > 0)
  639. {
  640. std::string range = llformat("Range: bytes=%d-%d", offset,offset+length-1);
  641. easy->slist_append(range.c_str());
  642. }
  643. easy->setHeaders();
  644. bool res = addEasy(easy);
  645. return res;
  646. }
  647. bool LLCurlRequest::post(const std::string& url,
  648.  const headers_t& headers,
  649.  const LLSD& data,
  650.  LLCurl::ResponderPtr responder)
  651. {
  652. LLCurl::Easy* easy = allocEasy();
  653. if (!easy)
  654. {
  655. return false;
  656. }
  657. easy->prepRequest(url, headers, responder);
  658. LLSDSerialize::toXML(data, easy->getInput());
  659. S32 bytes = easy->getInput().str().length();
  660. easy->setopt(CURLOPT_POST, 1);
  661. easy->setopt(CURLOPT_POSTFIELDS, (void*)NULL);
  662. easy->setopt(CURLOPT_POSTFIELDSIZE, bytes);
  663. easy->slist_append("Content-Type: application/llsd+xml");
  664. easy->setHeaders();
  665. lldebugs << "POSTING: " << bytes << " bytes." << llendl;
  666. bool res = addEasy(easy);
  667. return res;
  668. }
  669. // Note: call once per frame
  670. S32 LLCurlRequest::process()
  671. {
  672. llassert_always(mThreadID == LLThread::currentID());
  673. S32 res = 0;
  674. for (curlmulti_set_t::iterator iter = mMultiSet.begin();
  675.  iter != mMultiSet.end(); )
  676. {
  677. curlmulti_set_t::iterator curiter = iter++;
  678. LLCurl::Multi* multi = *curiter;
  679. S32 tres = multi->process();
  680. res += tres;
  681. if (multi != mActiveMulti && tres == 0 && multi->mQueued == 0)
  682. {
  683. mMultiSet.erase(curiter);
  684. delete multi;
  685. }
  686. }
  687. return res;
  688. }
  689. S32 LLCurlRequest::getQueued()
  690. {
  691. llassert_always(mThreadID == LLThread::currentID());
  692. S32 queued = 0;
  693. for (curlmulti_set_t::iterator iter = mMultiSet.begin();
  694.  iter != mMultiSet.end(); )
  695. {
  696. curlmulti_set_t::iterator curiter = iter++;
  697. LLCurl::Multi* multi = *curiter;
  698. queued += multi->mQueued;
  699. }
  700. return queued;
  701. }
  702. ////////////////////////////////////////////////////////////////////////////
  703. // For generating one easy request
  704. // associated with a single multi request
  705. LLCurlEasyRequest::LLCurlEasyRequest()
  706. : mRequestSent(false),
  707.   mResultReturned(false)
  708. {
  709. mMulti = new LLCurl::Multi();
  710. mEasy = mMulti->allocEasy();
  711. if (mEasy)
  712. {
  713. mEasy->setErrorBuffer();
  714. mEasy->setCA();
  715. }
  716. }
  717. LLCurlEasyRequest::~LLCurlEasyRequest()
  718. {
  719. delete mMulti;
  720. }
  721. void LLCurlEasyRequest::setopt(CURLoption option, S32 value)
  722. {
  723. if (mEasy)
  724. {
  725. mEasy->setopt(option, value);
  726. }
  727. }
  728. void LLCurlEasyRequest::setoptString(CURLoption option, const std::string& value)
  729. {
  730. if (mEasy)
  731. {
  732. mEasy->setoptString(option, value);
  733. }
  734. }
  735. void LLCurlEasyRequest::setPost(char* postdata, S32 size)
  736. {
  737. if (mEasy)
  738. {
  739. mEasy->setopt(CURLOPT_POST, 1);
  740. mEasy->setopt(CURLOPT_POSTFIELDS, postdata);
  741. mEasy->setopt(CURLOPT_POSTFIELDSIZE, size);
  742. }
  743. }
  744. void LLCurlEasyRequest::setHeaderCallback(curl_header_callback callback, void* userdata)
  745. {
  746. if (mEasy)
  747. {
  748. mEasy->setopt(CURLOPT_HEADERFUNCTION, (void*)callback);
  749. mEasy->setopt(CURLOPT_HEADERDATA, userdata); // aka CURLOPT_WRITEHEADER
  750. }
  751. }
  752. void LLCurlEasyRequest::setWriteCallback(curl_write_callback callback, void* userdata)
  753. {
  754. if (mEasy)
  755. {
  756. mEasy->setopt(CURLOPT_WRITEFUNCTION, (void*)callback);
  757. mEasy->setopt(CURLOPT_WRITEDATA, userdata);
  758. }
  759. }
  760. void LLCurlEasyRequest::setReadCallback(curl_read_callback callback, void* userdata)
  761. {
  762. if (mEasy)
  763. {
  764. mEasy->setopt(CURLOPT_READFUNCTION, (void*)callback);
  765. mEasy->setopt(CURLOPT_READDATA, userdata);
  766. }
  767. }
  768. void LLCurlEasyRequest::slist_append(const char* str)
  769. {
  770. if (mEasy)
  771. {
  772. mEasy->slist_append(str);
  773. }
  774. }
  775. void LLCurlEasyRequest::sendRequest(const std::string& url)
  776. {
  777. llassert_always(!mRequestSent);
  778. mRequestSent = true;
  779. lldebugs << url << llendl;
  780. if (mEasy)
  781. {
  782. mEasy->setHeaders();
  783. mEasy->setoptString(CURLOPT_URL, url);
  784. mMulti->addEasy(mEasy);
  785. }
  786. }
  787. void LLCurlEasyRequest::requestComplete()
  788. {
  789. llassert_always(mRequestSent);
  790. mRequestSent = false;
  791. if (mEasy)
  792. {
  793. mMulti->removeEasy(mEasy);
  794. }
  795. }
  796. S32 LLCurlEasyRequest::perform()
  797. {
  798. return mMulti->perform();
  799. }
  800. // Usage: Call getRestult until it returns false (no more messages)
  801. bool LLCurlEasyRequest::getResult(CURLcode* result, LLCurl::TransferInfo* info)
  802. {
  803. if (!mEasy)
  804. {
  805. // Special case - we failed to initialize a curl_easy (can happen if too many open files)
  806. //  Act as though the request failed to connect
  807. if (mResultReturned)
  808. {
  809. return false;
  810. }
  811. else
  812. {
  813. *result = CURLE_FAILED_INIT;
  814. mResultReturned = true;
  815. return true;
  816. }
  817. }
  818. // In theory, info_read might return a message with a status other than CURLMSG_DONE
  819. // In practice for all messages returned, msg == CURLMSG_DONE
  820. // Ignore other messages just in case
  821. while(1)
  822. {
  823. S32 q;
  824. CURLMsg* curlmsg = info_read(&q, info);
  825. if (curlmsg)
  826. {
  827. if (curlmsg->msg == CURLMSG_DONE)
  828. {
  829. *result = curlmsg->data.result;
  830. return true;
  831. }
  832. // else continue
  833. }
  834. else
  835. {
  836. return false;
  837. }
  838. }
  839. }
  840. // private
  841. CURLMsg* LLCurlEasyRequest::info_read(S32* q, LLCurl::TransferInfo* info)
  842. {
  843. if (mEasy)
  844. {
  845. CURLMsg* curlmsg = mMulti->info_read(q);
  846. if (curlmsg && curlmsg->msg == CURLMSG_DONE)
  847. {
  848. if (info)
  849. {
  850. mEasy->getTransferInfo(info);
  851. }
  852. }
  853. return curlmsg;
  854. }
  855. return NULL;
  856. }
  857. std::string LLCurlEasyRequest::getErrorString()
  858. {
  859. return mEasy ? std::string(mEasy->getErrorBuffer()) : std::string();
  860. }
  861. ////////////////////////////////////////////////////////////////////////////
  862. #if SAFE_SSL
  863. //static
  864. void LLCurl::ssl_locking_callback(int mode, int type, const char *file, int line)
  865. {
  866. if (mode & CRYPTO_LOCK)
  867. {
  868. LLCurl::sSSLMutex[type]->lock();
  869. }
  870. else
  871. {
  872. LLCurl::sSSLMutex[type]->unlock();
  873. }
  874. }
  875. //static
  876. unsigned long LLCurl::ssl_thread_id(void)
  877. {
  878. return LLThread::currentID();
  879. }
  880. #endif
  881. void LLCurl::initClass()
  882. {
  883. // Do not change this "unless you are familiar with and mean to control 
  884. // internal operations of libcurl"
  885. // - http://curl.haxx.se/libcurl/c/curl_global_init.html
  886. curl_global_init(CURL_GLOBAL_ALL);
  887. #if SAFE_SSL
  888. S32 mutex_count = CRYPTO_num_locks();
  889. for (S32 i=0; i<mutex_count; i++)
  890. {
  891. sSSLMutex.push_back(new LLMutex(NULL));
  892. }
  893. CRYPTO_set_id_callback(&LLCurl::ssl_thread_id);
  894. CRYPTO_set_locking_callback(&LLCurl::ssl_locking_callback);
  895. #endif
  896. }
  897. void LLCurl::cleanupClass()
  898. {
  899. #if SAFE_SSL
  900. CRYPTO_set_locking_callback(NULL);
  901. for_each(sSSLMutex.begin(), sSSLMutex.end(), DeletePointer());
  902. #endif
  903. curl_global_cleanup();
  904. }