957 lines
35 KiB
HTML
957 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>Module: Browser::Options</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="module">
|
|
|
|
<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/options_rb.html?TB_iframe=true&height=550&width=785"
|
|
class="thickbox" title="lib/common/browser/options.rb">lib/common/browser/options.rb</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div id="class-metadata">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<div id="method-list-section" class="section">
|
|
<h3 class="section-header">Methods</h3>
|
|
<ul class="link-list">
|
|
|
|
<li><a href="#method-i-basic_auth-3D">#basic_auth=</a></li>
|
|
|
|
<li><a href="#method-i-connect_timeout-3D">#connect_timeout=</a></li>
|
|
|
|
<li><a href="#method-i-invalid_proxy_auth_format">#invalid_proxy_auth_format</a></li>
|
|
|
|
<li><a href="#method-i-max_threads">#max_threads</a></li>
|
|
|
|
<li><a href="#method-i-max_threads-3D">#max_threads=</a></li>
|
|
|
|
<li><a href="#method-i-override_config">#override_config</a></li>
|
|
|
|
<li><a href="#method-i-proxy-3D">#proxy=</a></li>
|
|
|
|
<li><a href="#method-i-proxy_auth-3D">#proxy_auth=</a></li>
|
|
|
|
<li><a href="#method-i-request_timeout-3D">#request_timeout=</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="../WpTarget.html">WpTarget</a></li>
|
|
|
|
<li><a href="../WpTarget/Malwares.html">WpTarget::Malwares</a></li>
|
|
|
|
<li><a href="../WpTarget/WpConfigBackup.html">WpTarget::WpConfigBackup</a></li>
|
|
|
|
<li><a href="../WpTarget/WpCustomDirectories.html">WpTarget::WpCustomDirectories</a></li>
|
|
|
|
<li><a href="../WpTarget/WpFullPathDisclosure.html">WpTarget::WpFullPathDisclosure</a></li>
|
|
|
|
<li><a href="../WpTarget/WpLoginProtection.html">WpTarget::WpLoginProtection</a></li>
|
|
|
|
<li><a href="../WpTarget/WpReadme.html">WpTarget::WpReadme</a></li>
|
|
|
|
<li><a href="../WpTarget/WpRegistrable.html">WpTarget::WpRegistrable</a></li>
|
|
|
|
<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="../WpUsers.html">WpUsers</a></li>
|
|
|
|
<li><a href="../WpUsers/BruteForcable.html">WpUsers::BruteForcable</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="../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="../Browser.html">Browser</a></li>
|
|
|
|
<li><a href="../Browser/Actions.html">Browser::Actions</a></li>
|
|
|
|
<li><a href="../Browser/Options.html">Browser::Options</a></li>
|
|
|
|
<li><a href="../Terminal.html">Terminal</a></li>
|
|
|
|
<li><a href="../Terminal/Table.html">Terminal::Table</a></li>
|
|
|
|
<li><a href="../Terminal/Table/Style.html">Terminal::Table::Style</a></li>
|
|
|
|
<li><a href="../WebSite.html">WebSite</a></li>
|
|
|
|
<li><a href="../WebSite/InterestingHeaders.html">WebSite::InterestingHeaders</a></li>
|
|
|
|
<li><a href="../WebSite/RobotsTxt.html">WebSite::RobotsTxt</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="../WpUser.html">WpUser</a></li>
|
|
|
|
<li><a href="../WpUser/BruteForcable.html">WpUser::BruteForcable</a></li>
|
|
|
|
<li><a href="../WpUser/Existable.html">WpUser::Existable</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="../Array.html">Array</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="../File.html">File</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="../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="../VersionCompare.html">VersionCompare</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="module">Browser::Options</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="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="available_user_agents-attribute-method" class="method-detail">
|
|
<a name="available_user_agents"></a>
|
|
|
|
<a name="available_user_agents="></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">available_user_agents</span><span
|
|
class="attribute-access-type">[RW]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="basic_auth-attribute-method" class="method-detail">
|
|
<a name="basic_auth"></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">basic_auth</span><span
|
|
class="attribute-access-type">[R]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="cache_ttl-attribute-method" class="method-detail">
|
|
<a name="cache_ttl"></a>
|
|
|
|
<a name="cache_ttl="></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">cache_ttl</span><span
|
|
class="attribute-access-type">[RW]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="connect_timeout-attribute-method" class="method-detail">
|
|
<a name="connect_timeout"></a>
|
|
|
|
<a name="connect_timeout="></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">connect_timeout</span><span
|
|
class="attribute-access-type">[RW]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="proxy-attribute-method" class="method-detail">
|
|
<a name="proxy"></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">proxy</span><span
|
|
class="attribute-access-type">[R]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="proxy_auth-attribute-method" class="method-detail">
|
|
<a name="proxy_auth"></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">proxy_auth</span><span
|
|
class="attribute-access-type">[R]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="request_timeout-attribute-method" class="method-detail">
|
|
<a name="request_timeout"></a>
|
|
|
|
<a name="request_timeout="></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">request_timeout</span><span
|
|
class="attribute-access-type">[RW]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="user_agent-attribute-method" class="method-detail">
|
|
<a name="user_agent"></a>
|
|
|
|
<a name="user_agent="></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">user_agent</span><span
|
|
class="attribute-access-type">[W]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="user_agent_mode-attribute-method" class="method-detail">
|
|
<a name="user_agent_mode"></a>
|
|
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">user_agent_mode</span><span
|
|
class="attribute-access-type">[R]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div><!-- attribute-method-details -->
|
|
|
|
|
|
<!-- Methods -->
|
|
|
|
<div id="public-instance-method-details" class="method-section section">
|
|
<h3 class="section-header">Public Instance Methods</h3>
|
|
|
|
|
|
<div id="basic_auth-3D-method" class="method-detail ">
|
|
<a name="method-i-basic_auth-3D"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">basic_auth=</span><span
|
|
class="method-args">(auth)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Sets the Basic Authentification credentials Accepted format:</p>
|
|
|
|
<pre>login:password
|
|
Basic base_64_encoded</pre>
|
|
|
|
<p>@param [ String ] auth</p>
|
|
|
|
<p>@return [ void ]</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="basic_auth-3D-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser/options.rb, line 19</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">basic_auth=</span>(<span class="ruby-identifier">auth</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">index</span>(<span class="ruby-string">':'</span>)
|
|
<span class="ruby-ivar">@basic_auth</span> = <span class="ruby-node">"Basic #{Base64.encode64(auth).chomp}"</span>
|
|
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">auth</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\ABasic [a-zA-Z0-9=]+\z/</span>
|
|
<span class="ruby-ivar">@basic_auth</span> = <span class="ruby-identifier">auth</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Invalid basic authentication format, "login:password" or "Basic base_64_encoded" expected'</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- basic_auth-3D-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- basic_auth-3D-method -->
|
|
|
|
|
|
<div id="connect_timeout-3D-method" class="method-detail ">
|
|
<a name="method-i-connect_timeout-3D"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">connect_timeout=</span><span
|
|
class="method-args">(timeout)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Sets the connect timeout @param [ Integer ] timeout Timeout in ms</p>
|
|
|
|
<p>@return [ void ]</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="connect_timeout-3D-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser/options.rb, line 129</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">connect_timeout=</span>(<span class="ruby-identifier">timeout</span>)
|
|
<span class="ruby-ivar">@connect_timeout</span> = <span class="ruby-identifier">timeout</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- connect_timeout-3D-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- connect_timeout-3D-method -->
|
|
|
|
|
|
<div id="max_threads-method" class="method-detail ">
|
|
<a name="method-i-max_threads"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">max_threads</span><span
|
|
class="method-args">()</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>@return [ Integer ]</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="max_threads-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser/options.rb, line 30</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">max_threads</span>
|
|
<span class="ruby-ivar">@max_threads</span> <span class="ruby-operator">||</span> <span class="ruby-value">1</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- max_threads-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- max_threads-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">(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/options.rb, line 34</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">max_threads=</span>(<span class="ruby-identifier">threads</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">threads</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Integer</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">threads</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-ivar">@max_threads</span> = <span class="ruby-identifier">threads</span>
|
|
<span class="ruby-ivar">@hydra</span> = <span class="ruby-constant">Typhoeus</span><span class="ruby-operator">::</span><span class="ruby-constant">Hydra</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">max_concurrency</span><span class="ruby-operator">:</span> <span class="ruby-identifier">threads</span>)
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-string">'max_threads must be an Integer > 0'</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- max_threads-3D-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- max_threads-3D-method -->
|
|
|
|
|
|
<div id="proxy-3D-method" class="method-detail ">
|
|
<a name="method-i-proxy-3D"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">proxy=</span><span
|
|
class="method-args">(proxy)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Sets the proxy Accepted format:</p>
|
|
|
|
<pre> [protocol://]host:post
|
|
|
|
Supported protocols:
|
|
Depends on the curl protocols, See curl --version</pre>
|
|
|
|
<p>@param [ String ] proxy</p>
|
|
|
|
<p>@return [ void ]</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="proxy-3D-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser/options.rb, line 89</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">proxy=</span>(<span class="ruby-identifier">proxy</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">proxy</span>.<span class="ruby-identifier">index</span>(<span class="ruby-string">':'</span>)
|
|
<span class="ruby-ivar">@proxy</span> = <span class="ruby-identifier">proxy</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Invalid proxy format. Should be [protocol://]host:port.'</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- proxy-3D-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- proxy-3D-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">
|
|
|
|
<p>Sets the proxy credentials Accepted format:</p>
|
|
|
|
<pre>username:password
|
|
{ proxy_username: username, :proxy_password: password }</pre>
|
|
|
|
<p>@param [ String ] auth</p>
|
|
|
|
<p>@return [ void ]</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="proxy_auth-3D-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser/options.rb, line 105</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="request_timeout-3D-method" class="method-detail ">
|
|
<a name="method-i-request_timeout-3D"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">request_timeout=</span><span
|
|
class="method-args">(timeout)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Sets the request timeout @param [ Integer ] timeout Timeout in ms</p>
|
|
|
|
<p>@return [ void ]</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="request_timeout-3D-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser/options.rb, line 121</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">request_timeout=</span>(<span class="ruby-identifier">timeout</span>)
|
|
<span class="ruby-ivar">@request_timeout</span> = <span class="ruby-identifier">timeout</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- request_timeout-3D-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- request_timeout-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 [ String ] The user agent, according to the <a
|
|
href="Options.html#attribute-i-user_agent_mode">user_agent_mode</a></p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="user_agent-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser/options.rb, line 67</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">
|
|
|
|
<p>Sets the <a
|
|
href="Options.html#attribute-i-user_agent_mode">user_agent_mode</a>, which
|
|
can be one of the following:</p>
|
|
|
|
<pre>static: The UA is defined by the user, and will be the same in each requests
|
|
semi-static: The UA is randomly chosen at the first request, and will not change
|
|
random: UA randomly chosen each request</pre>
|
|
|
|
<p>UA are from @<a
|
|
href="Options.html#attribute-i-available_user_agents">available_user_agents</a></p>
|
|
|
|
<p>@param [ String ] ua_mode</p>
|
|
|
|
<p>@return [ void ]</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="user_agent_mode-3D-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser/options.rb, line 53</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 id="protected-instance-method-details" class="method-section section">
|
|
<h3 class="section-header">Protected Instance Methods</h3>
|
|
|
|
|
|
<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/options.rb, line 135</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="override_config-method" class="method-detail ">
|
|
<a name="method-i-override_config"></a>
|
|
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">override_config</span><span
|
|
class="method-args">(options = {})</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Override with the options if they are set @param [ Hash ] options</p>
|
|
|
|
<p>@return [ void ]</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="override_config-source">
|
|
<pre>
|
|
<span class="ruby-comment"># File lib/common/browser/options.rb, line 143</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">override_config</span>(<span class="ruby-identifier">options</span> = {})
|
|
<span class="ruby-identifier">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-identifier">value</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">and</span> <span class="ruby-constant">OPTIONS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">option</span>)
|
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:"#{option}="</span>, <span class="ruby-identifier">value</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- override_config-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- override_config-method -->
|
|
|
|
|
|
</div><!-- protected-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>
|
|
|