diff --git a/src/curl_wrapper/.clang-format b/src/curl_wrapper/.clang-format new file mode 100644 index 0000000..7f27975 --- /dev/null +++ b/src/curl_wrapper/.clang-format @@ -0,0 +1,131 @@ +# -*- mode: yaml -*- +# Written for clang-format 10. +# https://releases.llvm.org/10.0.0/tools/clang/docs/ClangFormatStyleOptions.html +--- +DisableFormat: false +Language: Cpp + +AccessModifierOffset: -4 +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: false +# AlignConsecutiveBitFields: false # clang-format 11 +AlignConsecutiveDeclarations: false +AlignConsecutiveMacros: false +AlignEscapedNewlines: DontAlign +AlignOperands: true # clang-format 11: Align +AlignTrailingComments: true +AllowAllArgumentsOnNextLine: false +AllowAllConstructorInitializersOnNextLine: false +AllowAllParametersOfDeclarationOnNextLine: false +AllowShortBlocksOnASingleLine: Empty +AllowShortCaseLabelsOnASingleLine: false +# AllowShortEnumsOnASingleLine: false # clang-format 11 +AllowShortFunctionsOnASingleLine: Empty +AllowShortIfStatementsOnASingleLine: Never +AllowShortLambdasOnASingleLine: Inline +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: Yes +BinPackArguments: true +BinPackParameters: true +BraceWrapping: # If BreakBeforeBraces is set to Custom. + AfterCaseLabel: true + AfterClass: true + AfterControlStatement: Always + AfterEnum: true + AfterFunction: true + AfterNamespace: true + AfterStruct: true + AfterUnion: true + AfterExternBlock: true + BeforeCatch: true + BeforeElse: true + # BeforeLambdaBody: true # clang-format 11 + # BeforeWhile: true # clang-format 11 + IndentBraces: false + SplitEmptyFunction: false + SplitEmptyRecord: false + SplitEmptyNamespace: false +BreakBeforeBinaryOperators: NonAssignment +BreakBeforeBraces: Custom +BreakBeforeTernaryOperators: true +BreakConstructorInitializers: BeforeComma +BreakInheritanceList: BeforeComma +BreakStringLiterals: true +ColumnLimit: 80 +# CommentPragmas: 'regex' +CompactNamespaces: false +ConstructorInitializerAllOnOneLineOrOnePerLine: false +ConstructorInitializerIndentWidth: 4 +ContinuationIndentWidth: 4 +Cpp11BracedListStyle: true +DeriveLineEnding: true +DerivePointerAlignment: false +FixNamespaceComments: true +ForEachMacros: + - FOREACH + - RANGES_FOR + - Q_FOREACH + - BOOST_FOREACH +IncludeBlocks: Regroup +IncludeCategories: # stdlib headers into own group. + - Regex: '^[^\.]+$' + Priority: 4 +# IndentCaseBlocks: false # clang-format 11 +IndentCaseLabels: false +# IndentExternBlock: NoIndent # clang-format 11 +IndentGotoLabels: false +IndentPPDirectives: AfterHash +IndentWidth: 4 +IndentWrappedFunctionNames: false +KeepEmptyLinesAtTheStartOfBlocks: true +# MacroBlockBegin: 'string' +# MacroBlockEnd: 'string' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: None +# NamespaceMacros: 'string' +PenaltyBreakAssignment: 250 +PenaltyBreakBeforeFirstCallParameter: 300 +# PenaltyBreakComment: 300 +# PenaltyBreakFirstLessLess: 120 +# PenaltyBreakString: 1000 +# PenaltyBreakTemplateDeclaration: 10 +# PenaltyExcessCharacter: 1000000 +# PenaltyReturnTypeOnItsOwnLine: 60 +PointerAlignment: Right +# RawStringFormats: # +ReflowComments: true +SortIncludes: true +SortUsingDeclarations: true +SpaceAfterCStyleCast: false +SpaceAfterLogicalNot: false +SpaceAfterTemplateKeyword: false +SpaceBeforeAssignmentOperators: true +SpaceBeforeCpp11BracedList: false +SpaceBeforeCtorInitializerColon: true +SpaceBeforeInheritanceColon: true +SpaceBeforeParens: ControlStatements +SpaceBeforeRangeBasedForLoopColon: true +SpaceBeforeSquareBrackets: false +SpaceInEmptyBlock: false +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 1 +SpacesInAngles: false +SpacesInCStyleCastParentheses: false +SpacesInConditionalStatement: false +SpacesInContainerLiterals: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +Standard: Auto +# StatementMacros: +# - Q_UNUSED +# - QT_REQUIRE_VERSION +TabWidth: 4 +# TypenameMacros: +# - STACK_OF +# - LIST +UseCRLF: false +UseTab: Never +# WhitespaceSensitiveMacros: ['string', 'string'] # clang-format 11 +... diff --git a/src/curl_wrapper/.editorconfig b/src/curl_wrapper/.editorconfig new file mode 100644 index 0000000..ad5e59f --- /dev/null +++ b/src/curl_wrapper/.editorconfig @@ -0,0 +1,20 @@ +# Configuration file for EditorConfig. +# More information is available under . + +root = true + +[*] +indent_style = space +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +max_line_length = 80 + +[*.?pp] +indent_size = 4 +tab_width = 4 + +[{CMakeLists.txt,*.cmake}] +indent_size = 2 +tab_width = 2 diff --git a/src/curl_wrapper/.gitignore b/src/curl_wrapper/.gitignore new file mode 100644 index 0000000..84c048a --- /dev/null +++ b/src/curl_wrapper/.gitignore @@ -0,0 +1 @@ +/build/ diff --git a/src/curl_wrapper/CMakeLists.txt b/src/curl_wrapper/CMakeLists.txt new file mode 100644 index 0000000..3976806 --- /dev/null +++ b/src/curl_wrapper/CMakeLists.txt @@ -0,0 +1,27 @@ +# Support version 3.9 and above, but use policy settings up to 3.17. +cmake_minimum_required(VERSION 3.9...3.17) +# Ranges are supported from 3.12, set policy to current for < 3.12. +if(${CMAKE_VERSION} VERSION_LESS 3.12) + cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}) +endif() + +project(curl_wrapper + VERSION 0.1.0 + DESCRIPTION "Light libcurl wrapper." + LANGUAGES CXX) + +option(WITH_CURL_WRAPPER_TESTS "Compile tests for curl_wrapper." NO) +option(WITH_CURL_WRAPPER_DOC "Compile API reference for curl_wrapper." NO) + +find_package(CURL 7.52 REQUIRED) + +add_subdirectory("src") + +if(WITH_CURL_WRAPPER_TESTS) + add_subdirectory("tests") +endif() + +if(WITH_CURL_WRAPPER_DOC) + include("cmake/Doxygen.cmake") + enable_doxygen("src") +endif() diff --git a/src/curl_wrapper/LICENSE b/src/curl_wrapper/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/src/curl_wrapper/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/src/curl_wrapper/README.adoc b/src/curl_wrapper/README.adoc new file mode 100644 index 0000000..80ceee0 --- /dev/null +++ b/src/curl_wrapper/README.adoc @@ -0,0 +1,65 @@ += curl_wrapper +:project: curl_wrapper +:uri-base: https://schlomp.space/tastytea/{project} +:uri-cmake: https://cmake.org/ +:uri-libcurl: https://curl.haxx.se/libcurl/ +:uri-catch: https://github.com/catchorg/Catch2 +:uri-doxygen: http://www.doxygen.nl/ + +Light libcurl wrapper for when you need to GET a website with minimum effort. + +This is _not_ supposed to be a package on its own, but a thing you drop into +your project. + +I made this because the curl wrapper I used before is no longer maintained and +the other wrappers are either incomplete or unmaintained as well. _I do not +guarantee anything, use at your own risk._ + +URL: <{uri-base}>. + +== Example program + +[source,cpp] +-------------------------------------------------------------------------------- +#include "curl_wrapper.hpp" +#include + +namespace cw = curl_wrapper; + +int main() +{ + cw::CURLWrapper curl; + const auto answer{curl.make_http_request(cw::http_method::GET, + "http://example.com/")}; + if (answer) + { + std::cout << answer; + } +} +-------------------------------------------------------------------------------- + +== Use with CMake + +Drop this project into a subfolder in your project tree. It will be compiled as +a static library. + +[source,cmake] +-------------------------------------------------------------------------------- +add_subdirectory(curl_wrapper) + +add_executable(test) +target_link_libraries(test PRIVATE curl_wrapper) +-------------------------------------------------------------------------------- + +.CMake options: +* `-DWITH_CURL_WRAPPER_TESTS=YES` Compiles the tests. +* `-DWITH_CURL_WRAPPER_DOC=YES` Generate API reference. + +== Dependencies + +* C++17 +* link:{uri-cmake}[CMake] >= 3.9 +* link:{uri-libcurl}[libcurl] >= 7.52 +* Optional: + ** Tests: link:{uri-catch}[Catch] >= 1.2 + ** Documentation: link:{uri-doxygen}[Doxygen] >= 1.8 diff --git a/src/curl_wrapper/cmake/Doxygen.cmake b/src/curl_wrapper/cmake/Doxygen.cmake new file mode 100644 index 0000000..b934b89 --- /dev/null +++ b/src/curl_wrapper/cmake/Doxygen.cmake @@ -0,0 +1,33 @@ +function(enable_doxygen) + find_package(Doxygen REQUIRED dot) + + set(DOXYGEN_RECURSIVE YES) + set(DOXYGEN_GENERATE_HTML YES) + set(DOXYGEN_HTML_OUTPUT "doc/html") + set(DOXYGEN_GENERATE_LATEX NO) + set(DOXYGEN_ALLOW_UNICODE_NAMES YES) + set(DOXYGEN_BRIEF_MEMBER_DESC YES) + set(DOXYGEN_REPEAT_BRIEF YES) + set(DOXYGEN_ALWAYS_DETAILED_SEC YES) + set(DOXYGEN_INLINE_INHERITED_MEMB NO) + set(DOXYGEN_INHERIT_DOCS YES) + set(DOXYGEN_SEPARATE_MEMBER_PAGES NO) + set(DOXYGEN_TAB_SIZE 4) + set(DOXYGEN_MARKDOWN_SUPPORT YES) + set(DOXYGEN_AUTOLINK_SUPPORT YES) + set(DOXYGEN_INLINE_SIMPLE_STRUCTS NO) + set(DOXYGEN_QUIET YES) + set(DOXYGEN_WARNINGS YES) + set(DOXYGEN_WARN_IF_UNDOCUMENTED YES) + set(DOXYGEN_BUILTIN_STL_SUPPORT YES) + set(DOXYGEN_VERBATIM_HEADERS YES) + set(DOXYGEN_INLINE_SOURCES YES) + set(DOXYGEN_SEARCHENGINE YES) + set(DOXYGEN_SHOW_FILES YES) + + file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/doc") + + doxygen_add_docs(${PROJECT_NAME}_doxygen "${ARGV}") + # Make sure doxygen is run with every build. + add_custom_target(${PROJECT_NAME}_docs ALL DEPENDS ${PROJECT_NAME}_doxygen) +endfunction() diff --git a/src/curl_wrapper/src/CMakeLists.txt b/src/curl_wrapper/src/CMakeLists.txt new file mode 100644 index 0000000..b664b2c --- /dev/null +++ b/src/curl_wrapper/src/CMakeLists.txt @@ -0,0 +1,22 @@ +file(GLOB sources "*.cpp") +file(GLOB headers "*.hpp") +add_library(${PROJECT_NAME} STATIC ${sources} ${headers}) +unset(sources) +unset(headers) + +set_target_properties(${PROJECT_NAME} + PROPERTIES + CXX_STANDARD 17 + CXX_STANDARD_REQUIRED ON + CXX_EXTENSIONS OFF) + +# FindCURL provides an IMPORTED target since CMake 3.12. +if(NOT ${CMAKE_VERSION} VERSION_LESS 3.12) + target_link_libraries(${PROJECT_NAME} PUBLIC CURL::libcurl) +else() + target_include_directories(${PROJECT_NAME} PUBLIC ${CURL_INCLUDE_DIRS}) + target_link_libraries(${PROJECT_NAME} PUBLIC ${CURL_LIBRARIES}) +endif() + +target_include_directories(${PROJECT_NAME} + PUBLIC "$") diff --git a/src/curl_wrapper/src/curl_wrapper.cpp b/src/curl_wrapper/src/curl_wrapper.cpp new file mode 100644 index 0000000..7255854 --- /dev/null +++ b/src/curl_wrapper/src/curl_wrapper.cpp @@ -0,0 +1,240 @@ +/* This file is part of curl_wrapper. + * Copyright © 2020 tastytea + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, version 3. + * + * This program 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +#include "curl_wrapper.hpp" + +#include "types.hpp" + +#include + +#include +#include +#include +#include +#include + +namespace curl_wrapper +{ + +inline static std::atomic curlwrapper_instances{0}; + +CURLWrapper::CURLWrapper() +{ + if (curlwrapper_instances == 0) + { + // NOLINTNEXTLINE(hicpp-signed-bitwise) + check(curl_global_init(CURL_GLOBAL_ALL)); + } + ++curlwrapper_instances; + + _connection = curl_easy_init(); + if (_connection == nullptr) + { + throw std::runtime_error{"Failed to initialize curl."}; + } + + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + curl_easy_setopt(_connection, CURLOPT_ERRORBUFFER, _buffer_error); + + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + curl_easy_setopt(_connection, CURLOPT_WRITEFUNCTION, writer_body_wrapper); + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + curl_easy_setopt(_connection, CURLOPT_WRITEDATA, this); + + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + curl_easy_setopt(_connection, CURLOPT_HEADERFUNCTION, + writer_headers_wrapper); + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + curl_easy_setopt(_connection, CURLOPT_HEADERDATA, this); + + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + check(curl_easy_setopt(_connection, CURLOPT_FOLLOWLOCATION, 1L)); + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + curl_easy_setopt(_connection, CURLOPT_MAXREDIRS, 5L); +} + +CURLWrapper::~CURLWrapper() noexcept +{ + curl_easy_cleanup(_connection); + --curlwrapper_instances; + + if (curlwrapper_instances == 0) + { + curl_global_cleanup(); + } +} + +string CURLWrapper::escape_url(const string_view url) const +{ + char *cbuf{curl_easy_escape(_connection, url.data(), + static_cast(url.size()))}; + string sbuf{cbuf}; + curl_free(cbuf); + return sbuf; +} + +string CURLWrapper::unescape_url(const string_view url) const +{ + char *cbuf{curl_easy_unescape(_connection, url.data(), + static_cast(url.size()), nullptr)}; + string sbuf{cbuf}; + curl_free(cbuf); + return sbuf; +} + +void CURLWrapper::set_useragent(const string_view useragent) +{ + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + check(curl_easy_setopt(_connection, CURLOPT_USERAGENT, useragent.data())); +} + +void CURLWrapper::set_proxy(const string_view proxy) +{ + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + check(curl_easy_setopt(_connection, CURLOPT_PROXY, proxy.data())); +} + +answer CURLWrapper::make_http_request(http_method method, string_view uri) +{ + _buffer_headers.clear(); + _buffer_body.clear(); + + switch (method) + { + case http_method::DELETE: + { + // NOTE: Use CURLOPT_MIMEPOST, then set to DELETE to send data. + + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + check(curl_easy_setopt(_connection, CURLOPT_CUSTOMREQUEST, "DELETE")); + + break; + } + case http_method::GET: + { + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + curl_easy_setopt(_connection, CURLOPT_HTTPGET, 1L); + + break; + } + case http_method::HEAD: + { + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + check(curl_easy_setopt(_connection, CURLOPT_CUSTOMREQUEST, "HEAD")); + + break; + } + case http_method::PATCH: + { + // NOTE: Use CURLOPT_MIMEPOST, then set to PATCH to send data. + + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + check(curl_easy_setopt(_connection, CURLOPT_CUSTOMREQUEST, "PATCH")); + + break; + } + case http_method::POST: + { + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + curl_easy_setopt(_connection, CURLOPT_POST, 1L); + + // NOTE: Use CURLOPT_MIMEPOST to send data. + + break; + } + case http_method::PUT: + { + // NOTE: Use CURLOPT_MIMEPOST, then set to PUT to send data. + + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + check(curl_easy_setopt(_connection, CURLOPT_CUSTOMREQUEST, "PUT")); + + break; + } + } + + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + check(curl_easy_setopt(_connection, CURLOPT_URL, uri.data())); + + try + { + check(curl_easy_perform(_connection)); + } + catch (const CURLException &e) + { + // PARTIAL_FILE error seems to be normal for HEAD requests. + if (!(method == http_method::HEAD + && e.error_code == CURLE_PARTIAL_FILE)) + { + std::rethrow_exception(std::current_exception()); + } + } + + long http_status{0}; // NOLINT(google-runtime-int) + // NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg) + check(curl_easy_getinfo(_connection, CURLINFO_RESPONSE_CODE, &http_status)); + return {static_cast(http_status), _buffer_headers, + _buffer_body}; +} + +size_t CURLWrapper::writer_body(char *data, size_t size, size_t nmemb) +{ + if (data == nullptr) + { + return 0; + } + + _buffer_body.append(data, size * nmemb); + + return size * nmemb; +} + +size_t CURLWrapper::writer_headers(char *data, size_t size, size_t nmemb) +{ + if (data == nullptr) + { + return 0; + } + + _buffer_headers.append(data, size * nmemb); + + return size * nmemb; +} + +void CURLWrapper::check(const CURLcode code) +{ + if (code != CURLE_OK) + { + throw CURLException{code, _buffer_error}; + } +} + +const char *CURLException::what() const noexcept +{ + // NOTE: The string has to be static, or it'll vanish before it can be + // used. Couldn't find good documentation on that. + static string error_string; + error_string = _error_message; + if (!error_string.empty()) + { + error_string = " – " + error_string; + } + error_string = "libcurl error: " + std::to_string(error_code) + + error_string; + return error_string.c_str(); +} + +} // namespace curl_wrapper diff --git a/src/curl_wrapper/src/curl_wrapper.hpp b/src/curl_wrapper/src/curl_wrapper.hpp new file mode 100644 index 0000000..62c6bfe --- /dev/null +++ b/src/curl_wrapper/src/curl_wrapper.hpp @@ -0,0 +1,244 @@ +/* This file is part of curl_wrapper. + * Copyright © 2020 tastytea + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, version 3. + * + * This program 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +#ifndef CURL_WRAPPER_HPP +#define CURL_WRAPPER_HPP + +#include "types.hpp" + +#include + +#include +#include +#include + +namespace curl_wrapper +{ + +using std::string; +using std::string_view; + +/*! + * @brief Light wrapper around libcurl. + * + * @since 0.1.0 + */ +class CURLWrapper +{ +public: + /*! + * @brief Initializes curl and sets up connection. + * + * The first time an instance of CURLWrapper is created, it calls + * `curl_global_init`, which is not thread-safe. For more information + * consult [curl_global_init(3)] + * (https://curl.haxx.se/libcurl/c/curl_global_init.html). + * + * May throw CURLException or std::runtime_error. + * + * @since 0.1.0 + */ + CURLWrapper(); + + /*! + * @brief Cleans up curl and connection. + * + * Calls `curl_global_cleanup`, which is not thread-safe, when the last + * instance of CURLWrapper is destroyed. For more information consult + * [curl_global_cleanup(3)] + * (https://curl.haxx.se/libcurl/c/curl_global_cleanup.html). + * + * @since 0.1.0 + */ + virtual ~CURLWrapper() noexcept; + + //! Copy constructor. @since 0.1.0 + CURLWrapper(const CURLWrapper &other) = delete; + + //! Move constructor @since 0.1.0 + CURLWrapper(CURLWrapper &&other) noexcept = delete; + + //! Copy assignment operator @since 0.1.0 + CURLWrapper &operator=(const CURLWrapper &other) = delete; + + //! Move assignment operator @since 0.1.0 + CURLWrapper &operator=(CURLWrapper &&other) noexcept = delete; + + /*! + * @brief Returns pointer to the CURL easy handle. + * + * You can use this handle to set or modify curl options. For more + * information consult [curl_easy_setopt(3)] + * (https://curl.haxx.se/libcurl/c/curl_easy_setopt.html). + * + * @since 0.1.0 + */ + [[nodiscard]] inline CURL *get_curl_easy_handle() const + { + return _connection; + } + + /*! + * @brief URL encodes the given string. + * + * For more information consult [curl_easy_escape(3)] + * (https://curl.haxx.se/libcurl/c/curl_easy_escape.html). + * + * @param url String to escape. + * + * @return The escaped string or {} if it failed. + * + * @since 0.1.0 + */ + [[nodiscard]] string escape_url(string_view url) const; + + /*! + * @brief URL decodes the given string. + * + * For more information consult [curl_easy_unescape(3)] + * (https://curl.haxx.se/libcurl/c/curl_easy_unescape.html). + * + * @param url String to unescape. + * + * @return The unescaped string or {} if it failed. + * + * @since 0.1.0 + */ + [[nodiscard]] string unescape_url(string_view url) const; + + /*! + * @brief Set the User-Agent. + * + * May throw CURLException. + * + * @since 0.1.0 + */ + void set_useragent(string_view useragent); + + /*! + * @brief Set a proxy. + * + * For more information consult [CURLOPT_PROXY(3)] + * (https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html). + * + * May throw CURLException. + * + * @since 0.1.1 + */ + void set_proxy(string_view proxy); + + /*! + * @brief Make a HTTP request. + * + * May throw CURLException. + * + * @param method The HTTP method. + * @param uri The full URI. + * + * @return The status code, headers and body of the page. + * + * @since 0.1.0 + */ + [[nodiscard]] answer make_http_request(http_method method, string_view uri); + +private: + CURL *_connection{}; + char _buffer_error[CURL_ERROR_SIZE]{}; + string _buffer_headers; + string _buffer_body; + + /*! + * @brief libcurl write callback function. + * + * @since 0.1.0 + */ + size_t writer_body(char *data, size_t size, size_t nmemb); + + /*! + * @brief Wrapper for curl, because it can only call static member + * functions. + * + * + * + * @since 0.1.0 + */ + static inline size_t writer_body_wrapper(char *data, size_t sz, + size_t nmemb, void *f) + { + return static_cast(f)->writer_body(data, sz, nmemb); + } + + //! @copydoc writer_body + size_t writer_headers(char *data, size_t size, size_t nmemb); + + //! @copydoc writer_body_wrapper + static inline size_t writer_headers_wrapper(char *data, size_t sz, + size_t nmemb, void *f) + { + return static_cast(f)->writer_headers(data, sz, nmemb); + } + + /*! + * @brief Throw CURLException if command doesn't return CURLE_OK. + * + * @since 0.1.0 + */ + void check(CURLcode code); +}; + +/*! + * @brief Exception for libcurl errors. + * + * @since 0.1.0 + */ +class CURLException : public std::exception +{ +public: + /*! + * @brief Constructor with error code. + * + * @since 0.1.0 + */ + explicit CURLException(const CURLcode code) + : error_code{code} + {} + + /*! + * @brief Constructor with error code and error buffer. + * + * @since 0.1.0 + */ + explicit CURLException(const CURLcode code, string_view error_buffer) + : error_code{code} + , _error_message{error_buffer} + {} + + const CURLcode error_code; //!< Error code from libcurl. + + /*! + * @brief Error message. + * + * @since 0.1.0 + */ + [[nodiscard]] const char *what() const noexcept override; + +private: + string _error_message; +}; + +} // namespace curl_wrapper + +#endif // CURL_WRAPPER_HPP diff --git a/src/curl_wrapper/src/types.cpp b/src/curl_wrapper/src/types.cpp new file mode 100644 index 0000000..a59430e --- /dev/null +++ b/src/curl_wrapper/src/types.cpp @@ -0,0 +1,51 @@ +/* This file is part of curl_wrapper. + * Copyright © 2020 tastytea + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, version 3. + * + * This program 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +#include "types.hpp" + +#include +#include +#include +#include + +namespace curl_wrapper +{ + +using std::tolower; + +std::string_view answer::get_header(const std::string_view field) const +{ + const string searchstring{string(field) += ":"}; + // clang-format off + auto it{std::search(headers.begin(), headers.end(), searchstring.begin(), + searchstring.end(), + [](unsigned char a, unsigned char b) + { return tolower(a) == tolower(b); })}; + // clang-format on + + if (it != headers.end()) + { + auto pos{static_cast(it - headers.begin())}; + pos = headers.find(':', pos) + 1; + pos = headers.find_first_not_of(' ', pos); + const auto endpos{headers.find_first_of("\r\n", pos)}; + return string_view(&headers[pos], endpos - pos); + } + + return {}; +} + +} // namespace curl_wrapper diff --git a/src/curl_wrapper/src/types.hpp b/src/curl_wrapper/src/types.hpp new file mode 100644 index 0000000..bad4dac --- /dev/null +++ b/src/curl_wrapper/src/types.hpp @@ -0,0 +1,106 @@ +/* This file is part of curl_wrapper. + * Copyright © 2020 tastytea + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, version 3. + * + * This program 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +#ifndef CURL_WRAPPER_TYPES_HPP +#define CURL_WRAPPER_TYPES_HPP + +#include +#include +#include +#include + +namespace curl_wrapper +{ + +using std::ostream; +using std::string; +using std::string_view; + +/*! + * @brief The HTTP method. + * + * @since 0.1.0 + */ +enum class http_method +{ + DELETE, + GET, + HEAD, + PATCH, + POST, + PUT +}; + +/*! + * @brief Return type for network requests. + * + * Currently only HTTP is considered. + * + * @since 0.1.0 + */ +struct answer +{ + std::uint16_t status{0}; //!< Status code. + string headers; //!< The headers of the response from the server. + string body; //!< The response from the server. + + /*! + * @brief Returns true if #status is 200. + * + * @since 0.1.0 + */ + [[nodiscard]] inline explicit operator bool() const + { + return (status == 200); + } + + /*! + * @brief Returns std::string_view of the #body. + * + * @since 0.1.0 + */ + [[nodiscard]] inline explicit operator string_view() const + { + return body; + } + + /*! + * @brief Returns #body as std::ostream. + * + * @since 0.1.0 + */ + inline friend ostream &operator<<(ostream &out, const answer &answer) + { + out << answer.body; + return out; + } + + /*! + * @brief Returns the value of a header field. + * + * @param field Case insensitive, ASCII only. + * + * @return A std::string_view to the value of the header field or {} if not + * found. + * + * @since 0.1.0 + */ + [[nodiscard]] string_view get_header(string_view field) const; +}; + +} // namespace curl_wrapper + +#endif // CURL_WRAPPER_TYPES_HPP diff --git a/src/curl_wrapper/tests/CMakeLists.txt b/src/curl_wrapper/tests/CMakeLists.txt new file mode 100644 index 0000000..1bd2bec --- /dev/null +++ b/src/curl_wrapper/tests/CMakeLists.txt @@ -0,0 +1,37 @@ +include(CTest) + +file(GLOB sources_tests "test_*.cpp") + +find_package(Catch2 CONFIG) +if(Catch2_FOUND) # Catch 2.x + include(Catch) + add_executable(all_tests main.cpp ${sources_tests}) + set_target_properties(all_tests + PROPERTIES + CXX_STANDARD 17 + CXX_STANDARD_REQUIRED ON + CXX_EXTENSIONS OFF) + target_link_libraries(all_tests + PRIVATE Catch2::Catch2 ${PROJECT_NAME}) + target_include_directories(all_tests PRIVATE "/usr/include/catch2") + catch_discover_tests(all_tests EXTRA_ARGS "${EXTRA_TEST_ARGS}") +else() # Catch 1.x + if(EXISTS "/usr/include/catch.hpp") + message(STATUS "Catch 1.x found.") + foreach(src ${sources_tests}) + get_filename_component(bin "${src}" NAME_WE) + add_executable(${bin} "main.cpp" "${src}") + set_target_properties(${bin} + PROPERTIES + CXX_STANDARD 17 + CXX_STANDARD_REQUIRED ON + CXX_EXTENSIONS OFF) + target_link_libraries(${bin} + PRIVATE ${PROJECT_NAME}) + add_test(${bin} ${bin} "${EXTRA_TEST_ARGS}") + endforeach() + else() + message(FATAL_ERROR + "Neither Catch 2.x nor Catch 1.x could be found.") + endif() +endif() diff --git a/src/curl_wrapper/tests/main.cpp b/src/curl_wrapper/tests/main.cpp new file mode 100644 index 0000000..e48147e --- /dev/null +++ b/src/curl_wrapper/tests/main.cpp @@ -0,0 +1,3 @@ +#define CATCH_CONFIG_MAIN + +#include diff --git a/src/curl_wrapper/tests/test_encode_decode.cpp b/src/curl_wrapper/tests/test_encode_decode.cpp new file mode 100644 index 0000000..6cbf643 --- /dev/null +++ b/src/curl_wrapper/tests/test_encode_decode.cpp @@ -0,0 +1,62 @@ +#include "curl_wrapper.hpp" + +#include + +#include +#include + +namespace curl_wrapper +{ + +using std::string; + +SCENARIO("URL encoding / decoding") +{ + const string text_raw{"Hüpfburg am rande!"}; + const string text_escaped("H%C3%BCpfburg%20am%20rande%21"); + + bool exception = false; + string answer; + + WHEN("Encoding " + text_raw) + { + try + { + CURLWrapper curl; + answer = curl.escape_url(text_raw); + } + catch (const std::exception &e) + { + exception = true; + } + + THEN("No exception is thrown") + AND_THEN("The text is successfully encoded") + { + REQUIRE_FALSE(exception); + REQUIRE(answer == text_escaped); + } + } + + WHEN("Decoding " + text_escaped) + { + try + { + CURLWrapper curl; + answer = curl.unescape_url(text_escaped); + } + catch (const std::exception &e) + { + exception = true; + } + + THEN("No exception is thrown") + AND_THEN("The text is successfully decoded") + { + REQUIRE_FALSE(exception); + REQUIRE(answer == text_raw); + } + } +} + +} // namespace curl_wrapper diff --git a/src/curl_wrapper/tests/test_get.cpp b/src/curl_wrapper/tests/test_get.cpp new file mode 100644 index 0000000..ffacf4d --- /dev/null +++ b/src/curl_wrapper/tests/test_get.cpp @@ -0,0 +1,41 @@ +#include "curl_wrapper.hpp" + +#include + +#include +#include + +namespace curl_wrapper +{ + +using std::string; + +SCENARIO("HTTP GET", "[http]") +{ + const string uri{"https://schlomp.space/api/v1/version"}; + + bool exception = false; + string answer; + + WHEN("GETing " + uri) + { + try + { + CURLWrapper curl; + answer = curl.make_http_request(http_method::GET, uri).body; + } + catch (const std::exception &e) + { + exception = true; + } + + THEN("No exception is thrown") + AND_THEN("We get the right answer") + { + REQUIRE_FALSE(exception); + REQUIRE(answer.substr(0, 11) == R"({"version":)"); + } + } +} + +} // namespace curl_wrapper diff --git a/src/curl_wrapper/tests/test_headers.cpp b/src/curl_wrapper/tests/test_headers.cpp new file mode 100644 index 0000000..7b52abd --- /dev/null +++ b/src/curl_wrapper/tests/test_headers.cpp @@ -0,0 +1,75 @@ +#include "types.hpp" + +#include + +#include +#include +#include +#include + +namespace curl_wrapper +{ + +using std::string; + +SCENARIO("Extract header") +{ + answer ret; + ret.headers = R"(HTTP/1.1 200 OK +Server: nginx/1.18.0 +Date: Sat, 07 Nov 2020 22:26:13 GMT +Content-Type: application/rss+xml; charset=utf-8 +Connection: keep-alive +Keep-Alive: timeout=20 +Expires: Sat, 07 Nov 2020 22:56:13 GMT +Cache-Control: max-age=1800 +X-Cache: HIT +X-UmläÜt: 🙂 +)"; + bool exception = false; + string value; + + WHEN("We search for “cache-control”") + { + try + { + value = ret.get_header("cache-control"); + } + catch (const std::exception &e) + { + std::cerr << "Exception: " << e.what() << '\n'; + exception = true; + } + + THEN("No exception is thrown") + AND_THEN("The value is successfully extracted") + { + REQUIRE_FALSE(exception); + REQUIRE(value == "max-age=1800"); + } + } + + // WHEN("We search for “X-UMLÄÜT”") + // { + // std::locale::global(std::locale("de_DE.UTF-8")); + // + // try + // { + // value = ret.get_header("X-UMLÄÜT"); + // } + // catch (const std::exception &e) + // { + // std::cerr << "Exception: " << e.what() << '\n'; + // exception = true; + // } + + // THEN("No exception is thrown") + // AND_THEN("The value is successfully extracted") + // { + // REQUIRE_FALSE(exception); + // REQUIRE(value == "🙂"); + // } + // } +} + +} // namespace curl_wrapper