File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/HTTPAuth/Htgroup.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WEBrick::HTTPAuth::Htgroup - 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-add">#add</a>
<li ><a href="#method-i-flush">#flush</a>
<li ><a href="#method-i-members">#members</a>
<li ><a href="#method-i-reload">#reload</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WEBrick::HTTPAuth::Htgroup">
<h1 id="class-WEBrick::HTTPAuth::Htgroup" class="class">
class WEBrick::HTTPAuth::Htgroup
</h1>
<section class="description">
<p><a href="Htgroup.html"><code>Htgroup</code></a> accesses apache-compatible group files. <a href="Htgroup.html"><code>Htgroup</code></a> can be used to provide group-based authentication for users. Currently <a href="Htgroup.html"><code>Htgroup</code></a> is not directly integrated with any authenticators in <a href="../../WEBrick.html"><code>WEBrick</code></a>. For security, the path for a digest password database should be stored outside of the paths available to the HTTP server.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">htgroup</span> = <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">Htgroup</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'my_group_file'</span>
<span class="ruby-identifier">htgroup</span>.<span class="ruby-identifier">add</span> <span class="ruby-string">'superheroes'</span>, <span class="ruby-node">%w[spiderman batman]</span>
<span class="ruby-identifier">htgroup</span>.<span class="ruby-identifier">members</span>(<span class="ruby-string">'superheroes'</span>).<span class="ruby-identifier">include?</span> <span class="ruby-string">'magneto'</span> <span class="ruby-comment"># => false</span>
</pre>
</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">(path)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Open a group database at <code>path</code></p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/webrick/httpauth/htgroup.rb, line 35</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-ivar">@path</span> = <span class="ruby-identifier">path</span>
<span class="ruby-ivar">@mtime</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">at</span>(<span class="ruby-value">0</span>)
<span class="ruby-ivar">@group</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@path</span>,<span class="ruby-string">"a"</span>).<span class="ruby-identifier">close</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-ivar">@path</span>)
<span class="ruby-identifier">reload</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-add" class="method-detail ">
<div class="method-heading">
<span class="method-name">add</span><span
class="method-args">(group, members)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Add an <a href="../../Array.html"><code>Array</code></a> of <code>members</code> to <code>group</code></p>
<div class="method-source-code" id="add-source">
<pre><span class="ruby-comment"># File lib/webrick/httpauth/htgroup.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add</span>(<span class="ruby-identifier">group</span>, <span class="ruby-identifier">members</span>)
<span class="ruby-ivar">@group</span>[<span class="ruby-identifier">group</span>] = <span class="ruby-identifier">members</span>(<span class="ruby-identifier">group</span>) <span class="ruby-operator">|</span> <span class="ruby-identifier">members</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-flush" class="method-detail ">
<div class="method-heading">
<span class="method-name">flush</span><span
class="method-args">(output=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Flush the group database. If <code>output</code> is given the database will be written there instead of to the original path.</p>
<div class="method-source-code" id="flush-source">
<pre><span class="ruby-comment"># File lib/webrick/httpauth/htgroup.rb, line 64</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">flush</span>(<span class="ruby-identifier">output</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">output</span> <span class="ruby-operator">||=</span> <span class="ruby-ivar">@path</span>
<span class="ruby-identifier">tmp</span> = <span class="ruby-constant">Tempfile</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"htgroup"</span>, <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">output</span>))
<span class="ruby-keyword">begin</span>
<span class="ruby-ivar">@group</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">group</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">tmp</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-identifier">format</span>(<span class="ruby-string">"%s: %s"</span>, <span class="ruby-identifier">group</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">members</span>(<span class="ruby-identifier">group</span>).<span class="ruby-identifier">join</span>(<span class="ruby-string">" "</span>)))
}
<span class="ruby-keyword">ensure</span>
<span class="ruby-identifier">tmp</span>.<span class="ruby-identifier">close</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">$!</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">unlink</span>(<span class="ruby-identifier">tmp</span>.<span class="ruby-identifier">path</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">rename</span>(<span class="ruby-identifier">tmp</span>.<span class="ruby-identifier">path</span>, <span class="ruby-identifier">output</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-members" class="method-detail ">
<div class="method-heading">
<span class="method-name">members</span><span
class="method-args">(group)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Retrieve the list of members from <code>group</code></p>
<div class="method-source-code" id="members-source">
<pre><span class="ruby-comment"># File lib/webrick/httpauth/htgroup.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">members</span>(<span class="ruby-identifier">group</span>)
<span class="ruby-identifier">reload</span>
<span class="ruby-ivar">@group</span>[<span class="ruby-identifier">group</span>] <span class="ruby-operator">||</span> []
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-reload" class="method-detail ">
<div class="method-heading">
<span class="method-name">reload</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reload groups from the database</p>
<div class="method-source-code" id="reload-source">
<pre><span class="ruby-comment"># File lib/webrick/httpauth/htgroup.rb, line 46</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reload</span>
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">mtime</span> = <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-identifier">mtime</span>(<span class="ruby-ivar">@path</span>)) <span class="ruby-operator">></span> <span class="ruby-ivar">@mtime</span>
<span class="ruby-ivar">@group</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@path</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">while</span> <span class="ruby-identifier">line</span> = <span class="ruby-identifier">io</span>.<span class="ruby-identifier">gets</span>
<span class="ruby-identifier">line</span>.<span class="ruby-identifier">chomp!</span>
<span class="ruby-identifier">group</span>, <span class="ruby-identifier">members</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/:\s*/</span>)
<span class="ruby-ivar">@group</span>[<span class="ruby-identifier">group</span>] = <span class="ruby-identifier">members</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/\s+/</span>)
<span class="ruby-keyword">end</span>
}
<span class="ruby-ivar">@mtime</span> = <span class="ruby-identifier">mtime</span>
<span class="ruby-keyword">end</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.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>