902 lines
35 KiB
HTML
902 lines
35 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
|
|
|
|
<title>Class: Browser</title>
|
|
|
|
<link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
|
|
|
|
<script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
|
|
|
|
</head>
|
|
<body id="top" class="class">
|
|
|
|
<div id="metadata">
|
|
<div id="home-metadata">
|
|
<div id="home-section" class="section">
|
|
<h3 class="section-header">
|
|
<a href="./index.html">Home</a>
|
|
<a href="./index.html#classes">Classes</a>
|
|
<a href="./index.html#methods">Methods</a>
|
|
</h3>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="file-metadata">
|
|
<div id="file-list-section" class="section">
|
|
<h3 class="section-header">In Files</h3>
|
|
<div class="section-body">
|
|
<ul>
|
|
|
|
<li><a href="./lib/common/browser_rb.html?TB_iframe=true&height=550&width=785"
|
|
class="thickbox" title="lib/common/browser.rb">lib/common/browser.rb</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div id="class-metadata">
|
|
|
|
<!-- Parent Class -->
|
|
<div id="parent-class-section" class="section">
|
|
<h3 class="section-header">Parent</h3>
|
|
|
|
<p class="link"><a href="Object.html">Object</a></p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<div id="method-list-section" class="section">
|
|
<h3 class="section-header">Methods</h3>
|
|
<ul class="link-list">
|
|
|
|
<li><a href="#method-c-instance">::instance</a></li>
|
|
|
|
<li><a href="#method-c-reset">::reset</a></li>
|
|
|
|
<li><a href="#method-i-forge_request">#forge_request</a></li>
|
|
|
|
<li><a href="#method-i-get">#get</a></li>
|
|
|
|
<li><a href="#method-i-get_and_follow_location">#get_and_follow_location</a></li>
|
|
|
|
<li><a href="#method-i-invalid_proxy_auth_format">#invalid_proxy_auth_format</a></li>
|
|
|
|
<li><a href="#method-i-load_config">#load_config</a></li>
|
|
|
|
<li><a href="#method-i-max_threads-3D">#max_threads=</a></li>
|
|
|
|
<li><a href="#method-i-merge_request_params">#merge_request_params</a></li>
|
|
|
|
<li><a href="#method-i-post">#post</a></li>
|
|
|
|
<li><a href="#method-i-proxy_auth-3D">#proxy_auth=</a></li>
|
|
|
|
<li><a href="#method-i-user_agent">#user_agent</a></li>
|
|
|
|
<li><a href="#method-i-user_agent_mode-3D">#user_agent_mode=</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="project-metadata">
|
|
|
|
|
|
<div id="fileindex-section" class="section project-section">
|
|
<h3 class="section-header">Files</h3>
|
|
<ul>
|
|
|
|
<li class="file"><a href="./CREDITS.html">CREDITS</a></li>
|
|
|
|
<li class="file"><a href="./Gemfile.html">Gemfile</a></li>
|
|
|
|
<li class="file"><a href="./LICENSE.html">LICENSE</a></li>
|
|
|
|
<li class="file"><a href="./README.html">README</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<div id="classindex-section" class="section project-section">
|
|
<h3 class="section-header">Class/Module Index
|
|
<span class="search-toggle"><img src="./images/find.png"
|
|
height="16" width="16" alt="[+]"
|
|
title="show/hide quicksearch" /></span></h3>
|
|
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
|
<fieldset>
|
|
<legend>Quicksearch</legend>
|
|
<input type="text" name="quicksearch" value=""
|
|
class="quicksearch-field" />
|
|
</fieldset>
|
|
</form>
|
|
|
|
<ul class="link-list">
|
|
|
|
<li><a href="./WpItem.html">WpItem</a></li>
|
|
|
|
<li><a href="./WpItem/Existable.html">WpItem::Existable</a></li>
|
|
|
|
<li><a href="./WpItem/Findable.html">WpItem::Findable</a></li>
|
|
|
|
<li><a href="./WpItem/Infos.html">WpItem::Infos</a></li>
|
|
|
|
<li><a href="./WpItem/Output.html">WpItem::Output</a></li>
|
|
|
|
<li><a href="./WpItem/Versionable.html">WpItem::Versionable</a></li>
|
|
|
|
<li><a href="./WpItem/Vulnerable.html">WpItem::Vulnerable</a></li>
|
|
|
|
<li><a href="./Typhoeus.html">Typhoeus</a></li>
|
|
|
|
<li><a href="./Typhoeus/Request.html">Typhoeus::Request</a></li>
|
|
|
|
<li><a href="./Typhoeus/Request/Cacheable.html">Typhoeus::Request::Cacheable</a></li>
|
|
|
|
<li><a href="./Typhoeus/Response.html">Typhoeus::Response</a></li>
|
|
|
|
<li><a href="./WpTheme.html">WpTheme</a></li>
|
|
|
|
<li><a href="./WpTheme/Findable.html">WpTheme::Findable</a></li>
|
|
|
|
<li><a href="./WpTheme/Versionable.html">WpTheme::Versionable</a></li>
|
|
|
|
<li><a href="./WpTheme/Vulnerable.html">WpTheme::Vulnerable</a></li>
|
|
|
|
<li><a href="./WpTimthumb.html">WpTimthumb</a></li>
|
|
|
|
<li><a href="./WpTimthumb/Existable.html">WpTimthumb::Existable</a></li>
|
|
|
|
<li><a href="./WpTimthumb/Output.html">WpTimthumb::Output</a></li>
|
|
|
|
<li><a href="./WpTimthumb/Versionable.html">WpTimthumb::Versionable</a></li>
|
|
|
|
<li><a href="./WpVersion.html">WpVersion</a></li>
|
|
|
|
<li><a href="./WpVersion/Findable.html">WpVersion::Findable</a></li>
|
|
|
|
<li><a href="./WpVersion/Output.html">WpVersion::Output</a></li>
|
|
|
|
<li><a href="./WpVersion/Vulnerable.html">WpVersion::Vulnerable</a></li>
|
|
|
|
<li><a href="./WpItems.html">WpItems</a></li>
|
|
|
|
<li><a href="./WpItems/Detectable.html">WpItems::Detectable</a></li>
|
|
|
|
<li><a href="./WpItems/Output.html">WpItems::Output</a></li>
|
|
|
|
<li><a href="./WpUsers.html">WpUsers</a></li>
|
|
|
|
<li><a href="./WpUsers/Detectable.html">WpUsers::Detectable</a></li>
|
|
|
|
<li><a href="./WpUsers/Output.html">WpUsers::Output</a></li>
|
|
|
|
<li><a href="./Vulnerabilities.html">Vulnerabilities</a></li>
|
|
|
|
<li><a href="./Vulnerabilities/Output.html">Vulnerabilities::Output</a></li>
|
|
|
|
<li><a href="./Vulnerability.html">Vulnerability</a></li>
|
|
|
|
<li><a href="./Vulnerability/Output.html">Vulnerability::Output</a></li>
|
|
|
|
<li><a href="./WpPlugin.html">WpPlugin</a></li>
|
|
|
|
<li><a href="./WpPlugin/Vulnerable.html">WpPlugin::Vulnerable</a></li>
|
|
|
|
<li><a href="./WpPlugins.html">WpPlugins</a></li>
|
|
|
|
<li><a href="./WpPlugins/Detectable.html">WpPlugins::Detectable</a></li>
|
|
|
|
<li><a href="./WpThemes.html">WpThemes</a></li>
|
|
|
|
<li><a href="./WpThemes/Detectable.html">WpThemes::Detectable</a></li>
|
|
|
|
<li><a href="./WpTimthumbs.html">WpTimthumbs</a></li>
|
|
|
|
<li><a href="./WpTimthumbs/Detectable.html">WpTimthumbs::Detectable</a></li>
|
|
|
|
<li><a href="./WpUser.html">WpUser</a></li>
|
|
|
|
<li><a href="./WpUser/Existable.html">WpUser::Existable</a></li>
|
|
|
|
<li><a href="./Array.html">Array</a></li>
|
|
|
|
<li><a href="./Browser.html">Browser</a></li>
|
|
|
|
<li><a href="./BruteForce.html">BruteForce</a></li>
|
|
|
|
<li><a href="./CacheFileStore.html">CacheFileStore</a></li>
|
|
|
|
<li><a href="./CheckerPlugin.html">CheckerPlugin</a></li>
|
|
|
|
<li><a href="./CustomOptionParser.html">CustomOptionParser</a></li>
|
|
|
|
<li><a href="./GenerateList.html">GenerateList</a></li>
|
|
|
|
<li><a href="./GitUpdater.html">GitUpdater</a></li>
|
|
|
|
<li><a href="./ListGeneratorPlugin.html">ListGeneratorPlugin</a></li>
|
|
|
|
<li><a href="./Malwares.html">Malwares</a></li>
|
|
|
|
<li><a href="./Object.html">Object</a></li>
|
|
|
|
<li><a href="./Plugin.html">Plugin</a></li>
|
|
|
|
<li><a href="./Plugins.html">Plugins</a></li>
|
|
|
|
<li><a href="./StatsPlugin.html">StatsPlugin</a></li>
|
|
|
|
<li><a href="./SvnParser.html">SvnParser</a></li>
|
|
|
|
<li><a href="./SvnUpdater.html">SvnUpdater</a></li>
|
|
|
|
<li><a href="./TyphoeusCache.html">TyphoeusCache</a></li>
|
|
|
|
<li><a href="./URI.html">URI</a></li>
|
|
|
|
<li><a href="./Updater.html">Updater</a></li>
|
|
|
|
<li><a href="./UpdaterFactory.html">UpdaterFactory</a></li>
|
|
|
|
<li><a href="./WebSite.html">WebSite</a></li>
|
|
|
|
<li><a href="./WpConfigBackup.html">WpConfigBackup</a></li>
|
|
|
|
<li><a href="./WpFullPathDisclosure.html">WpFullPathDisclosure</a></li>
|
|
|
|
<li><a href="./WpLoginProtection.html">WpLoginProtection</a></li>
|
|
|
|
<li><a href="./WpReadme.html">WpReadme</a></li>
|
|
|
|
<li><a href="./WpTarget.html">WpTarget</a></li>
|
|
|
|
<li><a href="./WpscanOptions.html">WpscanOptions</a></li>
|
|
|
|
</ul>
|
|
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="documentation">
|
|
<h1 class="class">Browser</h1>
|
|
|
|
<div id="description" class="description">
|
|
|
|
</div><!-- description -->
|
|
|
|
|
|
|
|
|
|
<div id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Constants -->
|
|
<div id="constants-list" class="section">
|
|
<h3 class="section-header">Constants</h3>
|
|
<dl>
|
|
|
|
<dt><a name="ACCESSOR_OPTIONS">ACCESSOR_OPTIONS</a></dt>
|
|
|
|
<dd class="description"></dd>
|
|
|
|
|
|
<dt><a name="USER_AGENT_MODES">USER_AGENT_MODES</a></dt>
|
|
|
|
<dd class="description"></dd>
|
|
|
|
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
|
|
<!-- Attributes -->
|
|
<div id="attribute-method-details" class="method-section section">
|
|
<h3 class="section-header">Attributes</h3>
|
|
|
|
|
|
<div id="config_file-attribute-method" class="method-detail">
|
|
<a name="config_file"></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">config_file</span><span
|
|
class="attribute-access-type">[R]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="hydra-attribute-method" class="method-detail">
|
|
<a name="hydra"></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">hydra</span><span
|
|
class="attribute-access-type">[R]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div><!-- attribute-method-details -->
|
|
|
|
|
|
<!-- Methods -->
|
|
|
|
<div id="public-class-method-details" class="method-section section">
|
|
<h3 class="section-header">Public Class Methods</h3>
|
|
|
|
|
|
<div id="instance-method" class="method-detail ">
|
|
<a name="method-c-instance"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">instance</span><span
|
|
class="method-args">(options = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="instance-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 48</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance</span>(<span class="ruby-identifier">options</span> = {})
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">@@instance</span>
|
|
<span class="ruby-identifier">@@instance</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">@@instance</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- instance-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- instance-method -->
|
|
|
|
|
|
<div id="reset-method" class="method-detail ">
|
|
<a name="method-c-reset"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">reset</span><span
|
|
class="method-args">()</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="reset-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 55</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">reset</span>
|
|
<span class="ruby-identifier">@@instance</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- reset-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- reset-method -->
|
|
|
|
|
|
</div><!-- public-class-method-details -->
|
|
|
|
<div id="public-instance-method-details" class="method-section section">
|
|
<h3 class="section-header">Public Instance Methods</h3>
|
|
|
|
|
|
<div id="forge_request-method" class="method-detail ">
|
|
<a name="method-i-forge_request"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">forge_request</span><span
|
|
class="method-args">(url, params = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="forge_request-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 146</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">forge_request</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span> = {})
|
|
<span class="ruby-constant">Typhoeus</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(
|
|
<span class="ruby-identifier">url</span>.<span class="ruby-identifier">to_s</span>,
|
|
<span class="ruby-identifier">merge_request_params</span>(<span class="ruby-identifier">params</span>)
|
|
)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- forge_request-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- forge_request-method -->
|
|
|
|
|
|
<div id="get-method" class="method-detail ">
|
|
<a name="method-i-get"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">get</span><span
|
|
class="method-args">(url, params = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="get-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 126</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span> = {})
|
|
<span class="ruby-identifier">run_request</span>(
|
|
<span class="ruby-identifier">forge_request</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">method</span><span class="ruby-operator">:</span> <span class="ruby-value">:get</span>))
|
|
)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- get-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- get-method -->
|
|
|
|
|
|
<div id="get_and_follow_location-method" class="method-detail ">
|
|
<a name="method-i-get_and_follow_location"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">get_and_follow_location</span><span
|
|
class="method-args">(url, params = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="get_and_follow_location-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 138</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_and_follow_location</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span> = {})
|
|
<span class="ruby-identifier">params</span>[<span class="ruby-value">:maxredirs</span>] <span class="ruby-operator">||=</span> <span class="ruby-value">2</span>
|
|
|
|
<span class="ruby-identifier">run_request</span>(
|
|
<span class="ruby-identifier">forge_request</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">method</span><span class="ruby-operator">:</span> <span class="ruby-value">:get</span>, <span class="ruby-identifier">followlocation</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>))
|
|
)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- get_and_follow_location-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- get_and_follow_location-method -->
|
|
|
|
|
|
<div id="invalid_proxy_auth_format-method" class="method-detail ">
|
|
<a name="method-i-invalid_proxy_auth_format"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">invalid_proxy_auth_format</span><span
|
|
class="method-args">()</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="invalid_proxy_auth_format-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 104</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">invalid_proxy_auth_format</span>
|
|
<span class="ruby-string">'Invalid proxy auth format, expected username:password or {proxy_username: username, proxy_password: password}'</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- invalid_proxy_auth_format-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- invalid_proxy_auth_format-method -->
|
|
|
|
|
|
<div id="load_config-method" class="method-detail ">
|
|
<a name="method-i-load_config"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">load_config</span><span
|
|
class="method-args">(config_file = nil)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>TODO reload hydra (if the .<a
|
|
href="Browser.html#method-i-load_config">load_config</a> is called on a
|
|
browser object, hydra will not have the new @max_threads and
|
|
@request_timeout)</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="load_config-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 110</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">load_config</span>(<span class="ruby-identifier">config_file</span> = <span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-ivar">@config_file</span> = <span class="ruby-identifier">config_file</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@config_file</span>
|
|
|
|
<span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">symlink?</span>(<span class="ruby-ivar">@config_file</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-string">"[ERROR] Config file is a symlink."</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">data</span> = <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-ivar">@config_file</span>))
|
|
<span class="ruby-keyword">end</span>
|
|
|
|
<span class="ruby-constant">ACCESSOR_OPTIONS</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">option</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">option_name</span> = <span class="ruby-identifier">option</span>.<span class="ruby-identifier">to_s</span>
|
|
|
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:"#{option_name}="</span>, <span class="ruby-identifier">data</span>[<span class="ruby-identifier">option_name</span>])
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- load_config-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- load_config-method -->
|
|
|
|
|
|
<div id="max_threads-3D-method" class="method-detail ">
|
|
<a name="method-i-max_threads-3D"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">max_threads=</span><span
|
|
class="method-args">(max_threads)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="max_threads-3D-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 85</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">max_threads=</span>(<span class="ruby-identifier">max_threads</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">max_threads</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">max_threads</span> <span class="ruby-operator"><=</span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">max_threads</span> = <span class="ruby-value">1</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@max_threads</span> = <span class="ruby-identifier">max_threads</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- max_threads-3D-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- max_threads-3D-method -->
|
|
|
|
|
|
<div id="merge_request_params-method" class="method-detail ">
|
|
<a name="method-i-merge_request_params"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">merge_request_params</span><span
|
|
class="method-args">(params = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="merge_request_params-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 153</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">merge_request_params</span>(<span class="ruby-identifier">params</span> = {})
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-constant">Browser</span>.<span class="ruby-identifier">append_params_header_field</span>(
|
|
<span class="ruby-identifier">params</span>,
|
|
<span class="ruby-string">'User-Agent'</span>,
|
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">user_agent</span>
|
|
)
|
|
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@proxy</span>
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">proxy</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@proxy</span>)
|
|
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@proxy_auth</span>
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">proxyauth</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@proxy_auth</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@basic_auth</span>
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-constant">Browser</span>.<span class="ruby-identifier">append_params_header_field</span>(
|
|
<span class="ruby-identifier">params</span>,
|
|
<span class="ruby-string">'Authorization'</span>,
|
|
<span class="ruby-ivar">@basic_auth</span>
|
|
)
|
|
<span class="ruby-keyword">end</span>
|
|
|
|
<span class="ruby-comment"># Used to enable the cache system if :cache_ttl > 0</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">params</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-value">:cache_ttl</span>)
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">cache_ttl</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@cache_ttl</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
|
|
<span class="ruby-comment"># Disable SSL-Certificate checks</span>
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">ssl_verifypeer</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>)
|
|
<span class="ruby-identifier">params</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">ssl_verifyhost</span><span class="ruby-operator">:</span> <span class="ruby-value">0</span>)
|
|
|
|
<span class="ruby-identifier">params</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- merge_request_params-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- merge_request_params-method -->
|
|
|
|
|
|
<div id="post-method" class="method-detail ">
|
|
<a name="method-i-post"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">post</span><span
|
|
class="method-args">(url, params = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="post-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 132</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">post</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span> = {})
|
|
<span class="ruby-identifier">run_request</span>(
|
|
<span class="ruby-identifier">forge_request</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">params</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">method</span><span class="ruby-operator">:</span> <span class="ruby-value">:post</span>))
|
|
)
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- post-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- post-method -->
|
|
|
|
|
|
<div id="proxy_auth-3D-method" class="method-detail ">
|
|
<a name="method-i-proxy_auth-3D"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">proxy_auth=</span><span
|
|
class="method-args">(auth)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="proxy_auth-3D-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 92</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">proxy_auth=</span>(<span class="ruby-identifier">auth</span>)
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">nil?</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-value">:proxy_username</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-value">:proxy_password</span>)
|
|
<span class="ruby-ivar">@proxy_auth</span> = <span class="ruby-identifier">auth</span>[<span class="ruby-value">:proxy_username</span>] <span class="ruby-operator">+</span> <span class="ruby-string">':'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">auth</span>[<span class="ruby-value">:proxy_password</span>]
|
|
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">index</span>(<span class="ruby-string">':'</span>) <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-ivar">@proxy_auth</span> = <span class="ruby-identifier">auth</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-identifier">invalid_proxy_auth_format</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- proxy_auth-3D-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- proxy_auth-3D-method -->
|
|
|
|
|
|
<div id="user_agent-method" class="method-detail ">
|
|
<a name="method-i-user_agent"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">user_agent</span><span
|
|
class="method-args">()</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>return the user agent, according to the user_agent_mode</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="user_agent-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 73</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">user_agent</span>
|
|
<span class="ruby-keyword">case</span> <span class="ruby-ivar">@user_agent_mode</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-string">'semi-static'</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@user_agent</span>
|
|
<span class="ruby-ivar">@user_agent</span> = <span class="ruby-ivar">@available_user_agents</span>.<span class="ruby-identifier">sample</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-string">'random'</span>
|
|
<span class="ruby-ivar">@user_agent</span> = <span class="ruby-ivar">@available_user_agents</span>.<span class="ruby-identifier">sample</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@user_agent</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- user_agent-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- user_agent-method -->
|
|
|
|
|
|
<div id="user_agent_mode-3D-method" class="method-detail ">
|
|
<a name="method-i-user_agent_mode-3D"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">user_agent_mode=</span><span
|
|
class="method-args">(ua_mode)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="user_agent_mode-3D-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser.rb, line 59</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">user_agent_mode=</span>(<span class="ruby-identifier">ua_mode</span>)
|
|
<span class="ruby-identifier">ua_mode</span> <span class="ruby-operator">||=</span> <span class="ruby-string">'static'</span>
|
|
|
|
<span class="ruby-keyword">if</span> <span class="ruby-constant">USER_AGENT_MODES</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">ua_mode</span>)
|
|
<span class="ruby-ivar">@user_agent_mode</span> = <span class="ruby-identifier">ua_mode</span>
|
|
<span class="ruby-comment"># For semi-static user agent mode, the user agent has to</span>
|
|
<span class="ruby-comment"># be nil the first time (it will be set with the getter)</span>
|
|
<span class="ruby-ivar">@user_agent</span> = <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ua_mode</span> <span class="ruby-operator">===</span> <span class="ruby-string">'semi-static'</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-node">"Unknow user agent mode : '#{ua_mode}'"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- user_agent_mode-3D-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- user_agent_mode-3D-method -->
|
|
|
|
|
|
</div><!-- public-instance-method-details -->
|
|
|
|
</div><!-- 5Buntitled-5D -->
|
|
|
|
|
|
</div><!-- documentation -->
|
|
|
|
<div id="validator-badges">
|
|
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
|
Rdoc Generator</a> 2</small>.</p>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|
|
|