96 lines
21 KiB
HTML
96 lines
21 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>remwharead: include/uri.hpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">remwharead
|
|
 <span id="projectnumber">0.8.4</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">uri.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* This file is part of remwharead.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright © 2019 tastytea <tastytea@tastytea.de></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * the Free Software Foundation, version 3.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * GNU General Public License for more details.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * along with this program. If not, see <http://www.gnu.org/licenses/>.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef REMWHAREAD_URI_HPP</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define REMWHAREAD_URI_HPP</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span>remwharead</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">using</span> std::string;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structremwharead_1_1html__extract.html"> 35</a></span> <span class="keyword">struct </span><a class="code" href="structremwharead_1_1html__extract.html">html_extract</a></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">bool</span> successful = <span class="keyword">false</span>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">string</span> error;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">string</span> title;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">string</span> description;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">string</span> fulltext;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">explicit</span> <span class="keyword">operator</span> bool();</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> };</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structremwharead_1_1archive__answer.html"> 55</a></span> <span class="keyword">struct </span><a class="code" href="structremwharead_1_1archive__answer.html">archive_answer</a></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">bool</span> successful = <span class="keyword">false</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">string</span> error;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">string</span> uri;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">explicit</span> <span class="keyword">operator</span> bool();</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> };</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classremwharead_1_1URI.html"> 71</a></span> <span class="keyword">class </span><a class="code" href="classremwharead_1_1URI.html">URI</a></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">explicit</span> <a class="code" href="classremwharead_1_1URI.html#a34633f88b14dcd2c3a618794040bc154">URI</a>(<span class="keywordtype">string</span> uri);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">virtual</span> ~<a class="code" href="classremwharead_1_1URI.html">URI</a>();</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="classremwharead_1_1URI.html#a34633f88b14dcd2c3a618794040bc154">URI</a>(<span class="keyword">const</span> <a class="code" href="classremwharead_1_1URI.html">URI</a> &other) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="classremwharead_1_1URI.html">URI</a> &operator=(<span class="keyword">const</span> <a class="code" href="classremwharead_1_1URI.html">URI</a> &other) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="classremwharead_1_1URI.html#a34633f88b14dcd2c3a618794040bc154">URI</a>(<a class="code" href="classremwharead_1_1URI.html">URI</a> &&other) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classremwharead_1_1URI.html">URI</a> &operator=(<a class="code" href="classremwharead_1_1URI.html">URI</a> &&other) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="structremwharead_1_1html__extract.html">html_extract</a> <a class="code" href="classremwharead_1_1URI.html#a32de53a91487e5cc68550d1479cbd081">get</a>();</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="structremwharead_1_1archive__answer.html">archive_answer</a> <a class="code" href="classremwharead_1_1URI.html#a20f272b5b1638269e5ef1bec69a7032e">archive</a>();</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">string</span> _uri;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#ad13540201da297653f5a8608e3b0df07">make_request</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &uri, <span class="keywordtype">bool</span> <a class="code" href="classremwharead_1_1URI.html#a20f272b5b1638269e5ef1bec69a7032e">archive</a> = <span class="keyword">false</span>) <span class="keyword">const</span>;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#aa67d8399d1637c09ba59e1af020055b7">extract_title</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &html);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#a77b680aacab6dbcbfe7d357b60e87842">extract_description</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &html);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#afe80e4fafe35023c25d109517ffd9388">strip_html</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &html);</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#a8b02cabdb493ba0db7931b9f51c05590">remove_html_tags</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &html, <span class="keyword">const</span> <span class="keywordtype">string</span> &tag = <span class="stringliteral">""</span>);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#a870da973d8a91bcaab28aa27e7cc3888">unescape_html</a>(<span class="keywordtype">string</span> html);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordtype">string</span> <a class="code" href="classremwharead_1_1URI.html#a063a1f5a633c1016883f134215809d27">remove_newlines</a>(<span class="keywordtype">string</span> text);</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keywordtype">void</span> <a class="code" href="classremwharead_1_1URI.html#a754c3e988f7d8890d6e9794bc1e69e2c">set_proxy</a>();</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> };</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> } <span class="comment">// namespace remwharead</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="preprocessor">#endif // REMWHAREAD_URI_HPP</span></div><div class="ttc" id="classremwharead_1_1URI_html_a32de53a91487e5cc68550d1479cbd081"><div class="ttname"><a href="classremwharead_1_1URI.html#a32de53a91487e5cc68550d1479cbd081">remwharead::URI::get</a></div><div class="ttdeci">html_extract get()</div><div class="ttdoc">Download URI and extract title, description and full text.</div><div class="ttdef"><b>Definition:</b> uri.cpp:126</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_a34633f88b14dcd2c3a618794040bc154"><div class="ttname"><a href="classremwharead_1_1URI.html#a34633f88b14dcd2c3a618794040bc154">remwharead::URI::URI</a></div><div class="ttdeci">URI(string uri)</div><div class="ttdoc">Construct object and set URL.</div><div class="ttdef"><b>Definition:</b> uri.cpp:66</div></div>
|
|
<div class="ttc" id="structremwharead_1_1html__extract_html"><div class="ttname"><a href="structremwharead_1_1html__extract.html">remwharead::html_extract</a></div><div class="ttdoc">A processed HTML page.</div><div class="ttdef"><b>Definition:</b> uri.hpp:35</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_a20f272b5b1638269e5ef1bec69a7032e"><div class="ttname"><a href="classremwharead_1_1URI.html#a20f272b5b1638269e5ef1bec69a7032e">remwharead::URI::archive</a></div><div class="ttdeci">archive_answer archive()</div><div class="ttdoc">Save URI in archive and return archive-URI.</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_a754c3e988f7d8890d6e9794bc1e69e2c"><div class="ttname"><a href="classremwharead_1_1URI.html#a754c3e988f7d8890d6e9794bc1e69e2c">remwharead::URI::set_proxy</a></div><div class="ttdeci">void set_proxy()</div><div class="ttdoc">Set proxy server.</div><div class="ttdef"><b>Definition:</b> uri.cpp:74</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_ad13540201da297653f5a8608e3b0df07"><div class="ttname"><a href="classremwharead_1_1URI.html#ad13540201da297653f5a8608e3b0df07">remwharead::URI::make_request</a></div><div class="ttdeci">string make_request(const string &uri, bool archive=false) const</div><div class="ttdoc">Make a HTTP(S) request.</div><div class="ttdef"><b>Definition:</b> uri.cpp:151</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_a870da973d8a91bcaab28aa27e7cc3888"><div class="ttname"><a href="classremwharead_1_1URI.html#a870da973d8a91bcaab28aa27e7cc3888">remwharead::URI::unescape_html</a></div><div class="ttdeci">string unescape_html(string html)</div><div class="ttdoc">Convert HTML entities to UTF-8.</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_afe80e4fafe35023c25d109517ffd9388"><div class="ttname"><a href="classremwharead_1_1URI.html#afe80e4fafe35023c25d109517ffd9388">remwharead::URI::strip_html</a></div><div class="ttdeci">string strip_html(const string &html)</div><div class="ttdoc">Removes HTML tags and superflous spaces from an HTML page.</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_aa67d8399d1637c09ba59e1af020055b7"><div class="ttname"><a href="classremwharead_1_1URI.html#aa67d8399d1637c09ba59e1af020055b7">remwharead::URI::extract_title</a></div><div class="ttdeci">string extract_title(const string &html)</div><div class="ttdoc">Extract the title from an HTML page.</div><div class="ttdef"><b>Definition:</b> uri.cpp:223</div></div>
|
|
<div class="ttc" id="structremwharead_1_1archive__answer_html"><div class="ttname"><a href="structremwharead_1_1archive__answer.html">remwharead::archive_answer</a></div><div class="ttdoc">The result of the call to the archive service.</div><div class="ttdef"><b>Definition:</b> uri.hpp:55</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_a063a1f5a633c1016883f134215809d27"><div class="ttname"><a href="classremwharead_1_1URI.html#a063a1f5a633c1016883f134215809d27">remwharead::URI::remove_newlines</a></div><div class="ttdeci">string remove_newlines(string text)</div><div class="ttdoc">Replace newlines with spaces.</div><div class="ttdef"><b>Definition:</b> uri.cpp:641</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html"><div class="ttname"><a href="classremwharead_1_1URI.html">remwharead::URI</a></div><div class="ttdoc">Download, archive and process an URI.</div><div class="ttdef"><b>Definition:</b> uri.hpp:71</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_a8b02cabdb493ba0db7931b9f51c05590"><div class="ttname"><a href="classremwharead_1_1URI.html#a8b02cabdb493ba0db7931b9f51c05590">remwharead::URI::remove_html_tags</a></div><div class="ttdeci">string remove_html_tags(const string &html, const string &tag="")</div><div class="ttdoc">Remove HTML tags.</div></div>
|
|
<div class="ttc" id="classremwharead_1_1URI_html_a77b680aacab6dbcbfe7d357b60e87842"><div class="ttname"><a href="classremwharead_1_1URI.html#a77b680aacab6dbcbfe7d357b60e87842">remwharead::URI::extract_description</a></div><div class="ttdeci">string extract_description(const string &html)</div><div class="ttdoc">Extract the description from an HTML page.</div><div class="ttdef"><b>Definition:</b> uri.cpp:240</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.15
|
|
</small></address>
|
|
</body>
|
|
</html>
|