443 lines
14 KiB
HTML
443 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
|
|
<title>class CacheFileStore - RDoc Documentation</title>
|
|
|
|
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
|
|
|
|
<script type="text/javascript">
|
|
var rdoc_rel_prefix = "./";
|
|
</script>
|
|
|
|
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
|
|
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
|
|
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
|
|
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
|
|
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
|
|
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
|
|
|
|
|
|
<body id="top" class="class">
|
|
<nav id="metadata">
|
|
<nav id="home-section" class="section">
|
|
<h3 class="section-header">
|
|
<a href="./index.html">Home</a>
|
|
<a href="./table_of_contents.html#classes">Classes</a>
|
|
<a href="./table_of_contents.html#methods">Methods</a>
|
|
</h3>
|
|
</nav>
|
|
|
|
|
|
<nav id="search-section" class="section project-section" class="initially-hidden">
|
|
<form action="#" method="get" accept-charset="utf-8">
|
|
<h3 class="section-header">
|
|
<input type="text" name="search" placeholder="Search" id="search-field"
|
|
title="Type to search, Up and Down to navigate, Enter to load">
|
|
</h3>
|
|
</form>
|
|
|
|
<ul id="search-results" class="initially-hidden"></ul>
|
|
</nav>
|
|
|
|
|
|
<div id="file-metadata">
|
|
<nav id="file-list-section" class="section">
|
|
<h3 class="section-header">Defined In</h3>
|
|
<ul>
|
|
<li>lib/cache_file_store.rb
|
|
</ul>
|
|
</nav>
|
|
|
|
|
|
</div>
|
|
|
|
<div id="class-metadata">
|
|
|
|
<nav id="parent-class-section" class="section">
|
|
<h3 class="section-header">Parent</h3>
|
|
|
|
<p class="link"><a href="Object.html">Object</a>
|
|
|
|
</nav>
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<nav id="method-list-section" class="section">
|
|
<h3 class="section-header">Methods</h3>
|
|
|
|
<ul class="link-list">
|
|
|
|
<li><a href="#method-c-new">::new</a>
|
|
|
|
<li><a href="#method-i-clean">#clean</a>
|
|
|
|
<li><a href="#method-i-get_entry_file_path">#get_entry_file_path</a>
|
|
|
|
<li><a href="#method-i-read_entry">#read_entry</a>
|
|
|
|
<li><a href="#method-i-write_entry">#write_entry</a>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
<div id="project-metadata">
|
|
<nav id="fileindex-section" class="section project-section">
|
|
<h3 class="section-header">Pages</h3>
|
|
|
|
<ul>
|
|
|
|
<li class="file"><a href="./CREDITS.html">CREDITS</a>
|
|
|
|
<li class="file"><a href="./Gemfile.html">Gemfile</a>
|
|
|
|
<li class="file"><a href="./README.html">README</a>
|
|
|
|
<li class="file"><a href="./log_txt.html">log</a>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
<nav id="classindex-section" class="section project-section">
|
|
<h3 class="section-header">Class and Module Index</h3>
|
|
|
|
<ul class="link-list">
|
|
|
|
<li><a href="./Array.html">Array</a>
|
|
|
|
<li><a href="./Browser.html">Browser</a>
|
|
|
|
<li><a href="./BruteForce.html">BruteForce</a>
|
|
|
|
<li><a href="./CacheFileStore.html">CacheFileStore</a>
|
|
|
|
<li><a href="./CheckerPlugin.html">CheckerPlugin</a>
|
|
|
|
<li><a href="./CustomOptionParser.html">CustomOptionParser</a>
|
|
|
|
<li><a href="./GenerateList.html">GenerateList</a>
|
|
|
|
<li><a href="./GitUpdater.html">GitUpdater</a>
|
|
|
|
<li><a href="./ListGeneratorPlugin.html">ListGeneratorPlugin</a>
|
|
|
|
<li><a href="./Malwares.html">Malwares</a>
|
|
|
|
<li><a href="./Object.html">Object</a>
|
|
|
|
<li><a href="./Plugin.html">Plugin</a>
|
|
|
|
<li><a href="./Plugins.html">Plugins</a>
|
|
|
|
<li><a href="./SvnParser.html">SvnParser</a>
|
|
|
|
<li><a href="./SvnUpdater.html">SvnUpdater</a>
|
|
|
|
<li><a href="./URI.html">URI</a>
|
|
|
|
<li><a href="./Updater.html">Updater</a>
|
|
|
|
<li><a href="./UpdaterFactory.html">UpdaterFactory</a>
|
|
|
|
<li><a href="./Vulnerable.html">Vulnerable</a>
|
|
|
|
<li><a href="./WebSite.html">WebSite</a>
|
|
|
|
<li><a href="./WpConfigBackup.html">WpConfigBackup</a>
|
|
|
|
<li><a href="./WpDetector.html">WpDetector</a>
|
|
|
|
<li><a href="./WpEnumerator.html">WpEnumerator</a>
|
|
|
|
<li><a href="./WpFullPathDisclosure.html">WpFullPathDisclosure</a>
|
|
|
|
<li><a href="./WpItem.html">WpItem</a>
|
|
|
|
<li><a href="./WpLoginProtection.html">WpLoginProtection</a>
|
|
|
|
<li><a href="./WpOptions.html">WpOptions</a>
|
|
|
|
<li><a href="./WpPlugin.html">WpPlugin</a>
|
|
|
|
<li><a href="./WpPlugins.html">WpPlugins</a>
|
|
|
|
<li><a href="./WpReadme.html">WpReadme</a>
|
|
|
|
<li><a href="./WpTarget.html">WpTarget</a>
|
|
|
|
<li><a href="./WpTheme.html">WpTheme</a>
|
|
|
|
<li><a href="./WpThemes.html">WpThemes</a>
|
|
|
|
<li><a href="./WpTimthumbs.html">WpTimthumbs</a>
|
|
|
|
<li><a href="./WpUser.html">WpUser</a>
|
|
|
|
<li><a href="./WpUsernames.html">WpUsernames</a>
|
|
|
|
<li><a href="./WpVersion.html">WpVersion</a>
|
|
|
|
<li><a href="./WpVulnerability.html">WpVulnerability</a>
|
|
|
|
<li><a href="./WpscanOptions.html">WpscanOptions</a>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="documentation">
|
|
<h1 class="class">class CacheFileStore</h1>
|
|
|
|
<div id="description" class="description">
|
|
|
|
</div><!-- description -->
|
|
|
|
|
|
|
|
|
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Attributes -->
|
|
<section id="attribute-method-details" class="method-section section">
|
|
<h3 class="section-header">Attributes</h3>
|
|
|
|
|
|
<div id="attribute-i-serializer" class="method-detail">
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">serializer</span><span
|
|
class="attribute-access-type">[R]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="attribute-i-storage_path" class="method-detail">
|
|
<div class="method-heading attribute-method-heading">
|
|
<span class="method-name">storage_path</span><span
|
|
class="attribute-access-type">[R]</span>
|
|
</div>
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section><!-- attribute-method-details -->
|
|
|
|
|
|
<!-- Methods -->
|
|
|
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
|
<h3 class="section-header">Public Class Methods</h3>
|
|
|
|
|
|
<div id="method-c-new" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">new</span><span
|
|
class="method-args">(storage_path, serializer = Marshal)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>The serializer must have the 2 methods .load and .dump</p>
|
|
|
|
<pre>(Marshal and YAML have them)</pre>
|
|
|
|
<p>YAML is Human Readable, contrary to Marshal which store in a binary format
|
|
Marshal does not need any “require”</p>
|
|
|
|
|
|
|
|
<div class="method-source-code" id="new-source">
|
|
<pre><span class="ruby-comment"># File lib/cache_file_store.rb, line 36</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">storage_path</span>, <span class="ruby-identifier">serializer</span> = <span class="ruby-constant">Marshal</span>)
|
|
<span class="ruby-ivar">@storage_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">storage_path</span>)
|
|
<span class="ruby-ivar">@serializer</span> = <span class="ruby-identifier">serializer</span>
|
|
|
|
<span class="ruby-comment"># File.directory? for ruby <= 1.9 otherwise,</span>
|
|
<span class="ruby-comment"># it makes more sense to do Dir.exist? :/</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-ivar">@storage_path</span>)
|
|
<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span>(<span class="ruby-ivar">@storage_path</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- new-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- new-method -->
|
|
|
|
|
|
</section><!-- public-class-method-details -->
|
|
|
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
|
<h3 class="section-header">Public Instance Methods</h3>
|
|
|
|
|
|
<div id="method-i-clean" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">clean</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="clean-source">
|
|
<pre><span class="ruby-comment"># File lib/cache_file_store.rb, line 47</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">clean</span>
|
|
<span class="ruby-constant">Dir</span>[<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@storage_path</span>, <span class="ruby-string">'*'</span>)].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-constant">File</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">f</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- clean-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- clean-method -->
|
|
|
|
|
|
<div id="method-i-get_entry_file_path" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">get_entry_file_path</span><span
|
|
class="method-args">(key)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="get_entry_file_path-source">
|
|
<pre><span class="ruby-comment"># File lib/cache_file_store.rb, line 69</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_entry_file_path</span>(<span class="ruby-identifier">key</span>)
|
|
<span class="ruby-ivar">@storage_path</span> <span class="ruby-operator">+</span> <span class="ruby-string">'/'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">key</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- get_entry_file_path-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- get_entry_file_path-method -->
|
|
|
|
|
|
<div id="method-i-read_entry" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">read_entry</span><span
|
|
class="method-args">(key)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="read_entry-source">
|
|
<pre><span class="ruby-comment"># File lib/cache_file_store.rb, line 53</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">read_entry</span>(<span class="ruby-identifier">key</span>)
|
|
<span class="ruby-identifier">entry_file_path</span> = <span class="ruby-identifier">get_entry_file_path</span>(<span class="ruby-identifier">key</span>)
|
|
|
|
<span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">entry_file_path</span>)
|
|
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@serializer</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">entry_file_path</span>))
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- read_entry-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- read_entry-method -->
|
|
|
|
|
|
<div id="method-i-write_entry" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">write_entry</span><span
|
|
class="method-args">(key, data_to_store, cache_timeout)</span>
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="write_entry-source">
|
|
<pre><span class="ruby-comment"># File lib/cache_file_store.rb, line 61</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier">write_entry</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">data_to_store</span>, <span class="ruby-identifier">cache_timeout</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">cache_timeout</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">get_entry_file_path</span>(<span class="ruby-identifier">key</span>), <span class="ruby-string">'w'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-ivar">@serializer</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">data_to_store</span>))
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div><!-- write_entry-source -->
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div><!-- write_entry-method -->
|
|
|
|
|
|
</section><!-- public-instance-method-details -->
|
|
|
|
</section><!-- 5Buntitled-5D -->
|
|
|
|
</div><!-- documentation -->
|
|
|
|
|
|
<footer id="validator-badges">
|
|
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
|
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
</footer>
|
|
|