mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 03:46:00 -07:00
1120 lines
63 KiB
HTML
1120 lines
63 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>class GxG::Networking::FtpClient - RDoc Documentation</title>
|
|
|
|
<script type="text/javascript">
|
|
var rdoc_rel_prefix = "../../";
|
|
var index_rel_prefix = "../../";
|
|
</script>
|
|
|
|
<script src="../../js/navigation.js" defer></script>
|
|
<script src="../../js/search.js" defer></script>
|
|
<script src="../../js/search_index.js" defer></script>
|
|
<script src="../../js/searcher.js" defer></script>
|
|
<script src="../../js/darkfish.js" defer></script>
|
|
|
|
<link href="../../css/fonts.css" rel="stylesheet">
|
|
<link href="../../css/rdoc.css" rel="stylesheet">
|
|
|
|
|
|
|
|
<body id="top" role="document" class="class">
|
|
<nav role="navigation">
|
|
<div id="project-navigation">
|
|
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
<h2>
|
|
<a href="../../index.html" rel="home">Home</a>
|
|
</h2>
|
|
|
|
<div id="table-of-contents-navigation">
|
|
<a href="../../table_of_contents.html#pages">Pages</a>
|
|
<a href="../../table_of_contents.html#classes">Classes</a>
|
|
<a href="../../table_of_contents.html#methods">Methods</a>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
<form action="#" method="get" accept-charset="utf-8">
|
|
<div id="search-field-wrapper">
|
|
<input id="search-field" role="combobox" aria-label="Search"
|
|
aria-autocomplete="list" aria-controls="search-results"
|
|
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
title="Type to search, Up and Down to navigate, Enter to load">
|
|
</div>
|
|
|
|
<ul id="search-results" aria-label="Search Results"
|
|
aria-busy="false" aria-expanded="false"
|
|
aria-atomic="false" class="initially-hidden"></ul>
|
|
</form>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div id="class-metadata">
|
|
|
|
<div id="parent-class-section" class="nav-section">
|
|
<h3>Parent</h3>
|
|
|
|
|
|
<p class="link"><a href="../../Object.html">Object</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<div id="method-list-section" class="nav-section">
|
|
<h3>Methods</h3>
|
|
|
|
<ul class="link-list" role="directory">
|
|
|
|
<li ><a href="#method-c-new">::new</a>
|
|
|
|
<li ><a href="#method-i-change_directory">#change_directory</a>
|
|
|
|
<li ><a href="#method-i-closed-3F">#closed?</a>
|
|
|
|
<li ><a href="#method-i-entries">#entries</a>
|
|
|
|
<li ><a href="#method-i-get_file">#get_file</a>
|
|
|
|
<li ><a href="#method-i-help">#help</a>
|
|
|
|
<li ><a href="#method-i-login">#login</a>
|
|
|
|
<li ><a href="#method-i-logout">#logout</a>
|
|
|
|
<li ><a href="#method-i-make_directory">#make_directory</a>
|
|
|
|
<li ><a href="#method-i-present_directory">#present_directory</a>
|
|
|
|
<li ><a href="#method-i-put_file">#put_file</a>
|
|
|
|
<li ><a href="#method-i-remove_directory">#remove_directory</a>
|
|
|
|
<li ><a href="#method-i-remove_file">#remove_file</a>
|
|
|
|
<li ><a href="#method-i-rename_file">#rename_file</a>
|
|
|
|
<li ><a href="#method-i-reopen">#reopen</a>
|
|
|
|
<li ><a href="#method-i-send_account_info">#send_account_info</a>
|
|
|
|
<li ><a href="#method-i-send_command">#send_command</a>
|
|
|
|
<li ><a href="#method-i-status">#status</a>
|
|
|
|
<li ><a href="#method-i-system_info">#system_info</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="class-GxG::Networking::FtpClient">
|
|
<h1 id="class-GxG::Networking::FtpClient" class="class">
|
|
class GxG::Networking::FtpClient
|
|
</h1>
|
|
|
|
<section class="description">
|
|
|
|
</section>
|
|
|
|
|
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Class Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-c-new" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">new</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="new-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4822</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>()
|
|
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">self</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Instance Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-i-change_directory" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">change_directory</span><span
|
|
class="method-args">(dir_name=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="change_directory-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5157</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_directory</span>(<span class="ruby-identifier">dir_name</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Attempted to access a closed session"</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">dir_name</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a directory path to change to."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">dir_name</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">pwd</span>() <span class="ruby-operator">!=</span> <span class="ruby-identifier">dir_name</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to change directory."</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:dir_name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">dir_name</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-closed-3F" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">closed?</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="closed-3F-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4912</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">closed?</span>()
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-entries" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">entries</span><span
|
|
class="method-args">(dir_name=nil, filter=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="entries-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5103</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">entries</span>(<span class="ruby-identifier">dir_name</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">filter</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-identifier">result</span> = []
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">dir_name</span>
|
|
<span class="ruby-identifier">dir_name</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">pwd</span>()
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-identifier">present_dir</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">pwd</span>()
|
|
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">dir_name</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">filter</span>
|
|
<span class="ruby-identifier">list</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">list</span>(<span class="ruby-identifier">filter</span>)
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">list</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">list</span>()
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">list</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-comment"># TODO: process entry text</span>
|
|
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">" "</span>)
|
|
<span class="ruby-identifier">record</span> = {<span class="ruby-value">:title</span> <span class="ruby-operator">=></span> <span class="ruby-string">""</span>, <span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-value">:virtual_directory</span>, <span class="ruby-value">:owner_type</span> <span class="ruby-operator">=></span> <span class="ruby-value">:virtual_directory</span>, <span class="ruby-value">:on_device</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:on_device_major</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:on_device_minor</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:is_device</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:is_device_major</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:is_device_minor</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:inode</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:flags</span> <span class="ruby-operator">=></span> [<span class="ruby-value">:read</span>], <span class="ruby-value">:hardlinks_to</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>, <span class="ruby-value">:user_id</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:group_id</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:size</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>, <span class="ruby-value">:block_size</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>, <span class="ruby-value">:blocks</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>, <span class="ruby-value">:accessed</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:modified</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:status_modified</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:permissions</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:mode</span><span class="ruby-operator">=></span><span class="ruby-keyword">nil</span>}
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-identifier">record</span>[<span class="ruby-value">:permissions</span>] = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">unix_permissions_to_gxg</span>(<span class="ruby-identifier">data</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">to_s</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">record</span>[<span class="ruby-value">:permissions</span>][<span class="ruby-value">:other</span>][<span class="ruby-value">:write</span>]
|
|
<span class="ruby-identifier">record</span>[<span class="ruby-value">:flags</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:write</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># record[:owner] = data[2]</span>
|
|
<span class="ruby-comment"># record[:group] = data[3]</span>
|
|
<span class="ruby-identifier">record</span>[<span class="ruby-value">:size</span>] = <span class="ruby-identifier">data</span>[<span class="ruby-value">4</span>].<span class="ruby-identifier">to_i</span>
|
|
<span class="ruby-identifier">record</span>[<span class="ruby-value">:modified</span>] = <span class="ruby-operator">::</span><span class="ruby-constant">DateTime</span><span class="ruby-operator">::</span><span class="ruby-identifier">parse</span>(<span class="ruby-identifier">data</span>[<span class="ruby-value">5</span><span class="ruby-operator">..</span><span class="ruby-value">7</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">" "</span>))
|
|
<span class="ruby-identifier">record</span>[<span class="ruby-value">:title</span>] = <span class="ruby-identifier">data</span>[<span class="ruby-value">8</span>]
|
|
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">record</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">present_dir</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:dir_name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">dir_name</span>, <span class="ruby-value">:filter</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">filter</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-get_file" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">get_file</span><span
|
|
class="method-args">(file_name=nil, save_path=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="get_file-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5025</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_file</span>(<span class="ruby-identifier">file_name</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">save_path</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">save_path</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">getbinaryfile</span>(<span class="ruby-identifier">file_name</span>, <span class="ruby-identifier">save_path</span>, <span class="ruby-value">1024</span>)
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">ByteArray</span>.<span class="ruby-identifier">new</span>
|
|
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">getbinaryfile</span>(<span class="ruby-identifier">file_name</span>, <span class="ruby-identifier">save_path</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">data_chunk</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data_chunk</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:file_name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">file_name</span>, <span class="ruby-value">:save_path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">save_path</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-help" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">help</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="help-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4952</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">help</span>()
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Attempted to access a closed connection."</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">help</span>()
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-login" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">login</span><span
|
|
class="method-args">(the_url=nil, options={})</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="login-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4827</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">login</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-identifier">login_options</span> = {}
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">Generic</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># The available options are:</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-comment"># port:: Port number (default value is 21)</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:port</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
|
<span class="ruby-identifier">login_options</span>[<span class="ruby-value">:port</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:port</span>].<span class="ruby-identifier">to_i</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># ssl:: If options[:ssl] is true, then an attempt will be made</span>
|
|
<span class="ruby-comment"># to use SSL (now TLS) to connect to the server. For this</span>
|
|
<span class="ruby-comment"># to work OpenSSL [OSSL] and the Ruby OpenSSL [RSSL]</span>
|
|
<span class="ruby-comment"># extensions need to be installed. If options[:ssl] is a</span>
|
|
<span class="ruby-comment"># hash, it's passed to OpenSSL::SSL::SSLContext#set_params</span>
|
|
<span class="ruby-comment"># as parameters.</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
|
<span class="ruby-identifier">login_options</span>[<span class="ruby-value">:ssl</span>] = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># private_data_connection:: If true, TLS is used for data connections.</span>
|
|
<span class="ruby-comment"># Default: +true+ when options[:ssl] is true.</span>
|
|
<span class="ruby-comment"># username:: Username for login. If options[:username] is the string</span>
|
|
<span class="ruby-comment"># "anonymous" and the options[:password] is +nil+,</span>
|
|
<span class="ruby-comment"># "anonymous@" is used as a password.</span>
|
|
<span class="ruby-identifier">login_options</span>[<span class="ruby-value">:username</span>] = <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>
|
|
<span class="ruby-comment"># password:: Password for login.</span>
|
|
<span class="ruby-identifier">login_options</span>[<span class="ruby-value">:password</span>] = <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>
|
|
<span class="ruby-comment"># account:: Account information for ACCT.</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:account_info</span>]
|
|
<span class="ruby-identifier">login_options</span>[<span class="ruby-value">:account</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:account_info</span>]
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># passive:: When +true+, the connection is in passive mode. Default:</span>
|
|
<span class="ruby-comment"># +true+.</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:passive</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span>
|
|
<span class="ruby-identifier">login_options</span>[<span class="ruby-value">:passive</span>] = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># open_timeout:: Number of seconds to wait for the connection to open.</span>
|
|
<span class="ruby-comment"># See Net::FTP#open_timeout for details. Default: +nil+.</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:open_timeout</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
|
<span class="ruby-identifier">login_options</span>[<span class="ruby-value">:open_timeout</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:open_timeout</span>]
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># read_timeout:: Number of seconds to wait for one block to be read.</span>
|
|
<span class="ruby-comment"># See Net::FTP#read_timeout for details. Default: +60+.</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:read_timeout</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
|
<span class="ruby-identifier">login_options</span>[<span class="ruby-value">:read_timeout</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:read_timeout</span>]
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment"># ssl_handshake_timeout:: Number of seconds to wait for the TLS</span>
|
|
<span class="ruby-comment"># handshake.</span>
|
|
<span class="ruby-comment"># See Net::FTP#ssl_handshake_timeout for</span>
|
|
<span class="ruby-comment"># details. Default: +nil+.</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:ssl_handshake_timeout</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
|
<span class="ruby-identifier">login_options</span>[<span class="ruby-value">:ssl_handshake_timeout</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:ssl_handshake_timeout</span>]
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-ivar">@client</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">FTP</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">login_options</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">FTP</span>)
|
|
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">login</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to log into FTP session"</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to create FTP session"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-logout" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">logout</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="logout-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4901</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">logout</span>()
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">close</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-make_directory" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">make_directory</span><span
|
|
class="method-args">(dir_name=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="make_directory-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5181</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">make_directory</span>(<span class="ruby-identifier">dir_name</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Attempted to access a closed session"</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">dir_name</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a directory path to create."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">mkdir</span>(<span class="ruby-identifier">dir_name</span>)
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">result</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to change directory."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:dir_name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">dir_name</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-present_directory" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">present_directory</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="present_directory-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5141</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">present_directory</span>()
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Attempted to access a closed session"</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">pwd</span>()
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-put_file" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">put_file</span><span
|
|
class="method-args">(local_path=nil, remote_file=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="put_file-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5044</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">put_file</span>(<span class="ruby-identifier">local_path</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">remote_file</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">putbinaryfile</span>(<span class="ruby-identifier">local_path</span>, <span class="ruby-identifier">remote_file</span>, <span class="ruby-value">1024</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:local_path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">local_path</span>, <span class="ruby-value">:remote_file</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">remote_file</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-remove_directory" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">remove_directory</span><span
|
|
class="method-args">(dir_name=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="remove_directory-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5203</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">remove_directory</span>(<span class="ruby-identifier">dir_name</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Attempted to access a closed session"</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">dir_name</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a directory name to remove."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">rmdir</span>(<span class="ruby-identifier">dir_name</span>)
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">result</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to remove directory."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:dir_name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">dir_name</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-remove_file" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">remove_file</span><span
|
|
class="method-args">(file_name=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="remove_file-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5081</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">remove_file</span>(<span class="ruby-identifier">file_name</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Attempted to access a closed session"</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">file_name</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a file name to remove."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">file_name</span>)
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">result</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to remove file."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:file_name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">file_name</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-rename_file" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">rename_file</span><span
|
|
class="method-args">(file_name=nil, new_file_name=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="rename_file-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5056</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rename_file</span>(<span class="ruby-identifier">file_name</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">new_file_name</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Attempted to access a closed session"</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">file_name</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a current file name to rename."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">new_file_name</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a new name to rename the file."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">rename</span>(<span class="ruby-identifier">file_name</span>, <span class="ruby-identifier">new_file_name</span>)
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">result</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to rename file."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:file_name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">file_name</span>, <span class="ruby-value">:new_file_name</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">new_file_name</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-reopen" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">reopen</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="reopen-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5006</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reopen</span>()
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">connect</span>()
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to re-open connection."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-send_account_info" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">send_account_info</span><span
|
|
class="method-args">(acct_info=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="send_account_info-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4968</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_account_info</span>(<span class="ruby-identifier">acct_info</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Attempted to access a closed connection."</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">acct_info</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide account information (as a String)."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">acct</span>(<span class="ruby-identifier">acct_info</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:account_info</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">acct_info</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-send_command" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">send_command</span><span
|
|
class="method-args">(command=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="send_command-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4987</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_command</span>(<span class="ruby-identifier">command</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Attempted to access a closed connection."</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">command</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You must provide a String to issue FTP commands."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">sendcmd</span>(<span class="ruby-identifier">command</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:command</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">command</span>}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-status" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">status</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="status-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4920</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">status</span>()
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Attempted to access a closed connection."</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">status</span>()
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-system_info" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">system_info</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="system_info-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4936</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">system_info</span>()
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Attempted to access a closed connection."</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">system</span>()
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
|
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
</section>
|
|
</main>
|
|
|
|
|
|
<footer id="validator-badges" role="contentinfo">
|
|
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
|
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
</footer>
|
|
|