vbatts/pkg
1
0
Fork 0
Code Pull requests Releases Activity

added documentation for functions

Browse source 
Signed-off-by: Jason Smith <jasonrichardsmith@gmail.com>
This commit is contained in:
Jason Smith 2015-03-23 19:46:22 -04:00 committed by Arnaud Porterie
parent 6a30cca4ed
commit 7b823090ed
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
etchosts/etchosts.go
View file

@ -8,16 +8,19 @@ import (
"regexp" "regexp"
) )
// Structure for a single host record
type Record struct { type Record struct {
Hosts string Hosts string
IP string IP string
} }
// Writes record to file and returns bytes written or error
func (r Record) WriteTo(w io.Writer) (int64, error) { func (r Record) WriteTo(w io.Writer) (int64, error) {
n, err := fmt.Fprintf(w, "%s\t%s\n", r.IP, r.Hosts) n, err := fmt.Fprintf(w, "%s\t%s\n", r.IP, r.Hosts)
return int64(n), err return int64(n), err
} }
// Default hosts config records slice
var defaultContent = []Record{ var defaultContent = []Record{
{Hosts: "localhost", IP: "127.0.0.1"}, {Hosts: "localhost", IP: "127.0.0.1"},
{Hosts: "localhost ip6-localhost ip6-loopback", IP: "::1"}, {Hosts: "localhost ip6-localhost ip6-loopback", IP: "::1"},
@ -27,9 +30,14 @@ var defaultContent = []Record{
{Hosts: "ip6-allrouters", IP: "ff02::2"}, {Hosts: "ip6-allrouters", IP: "ff02::2"},
} }
// Build function
// path is path to host file string required
// IP, hostname, and domainname set main record leave empty for no master record
// extraContent is an array of extra host records.
func Build(path, IP, hostname, domainname string, extraContent []Record) error { func Build(path, IP, hostname, domainname string, extraContent []Record) error {
content := bytes.NewBuffer(nil) content := bytes.NewBuffer(nil)
if IP != "" { if IP != "" {
//set main record
var mainRec Record var mainRec Record
mainRec.IP = IP mainRec.IP = IP
if domainname != "" { if domainname != "" {
@ -41,13 +49,13 @@ func Build(path, IP, hostname, domainname string, extraContent []Record) error {
return err return err
} }
} }
// Write defaultContent slice to buffer
for _, r := range defaultContent { for _, r := range defaultContent {
if _, err := r.WriteTo(content); err != nil { if _, err := r.WriteTo(content); err != nil {
return err return err
} }
} }
// Write extra content from function arguments
for _, r := range extraContent { for _, r := range extraContent {
if _, err := r.WriteTo(content); err != nil { if _, err := r.WriteTo(content); err != nil {
return err return err
@ -57,6 +65,10 @@ func Build(path, IP, hostname, domainname string, extraContent []Record) error {
return ioutil.WriteFile(path, content.Bytes(), 0644) return ioutil.WriteFile(path, content.Bytes(), 0644)
} }
// Update all IP addresses where hostname matches.
// path is path to host file
// IP is new IP address
// hostname is hostname to search for to replace IP
func Update(path, IP, hostname string) error { func Update(path, IP, hostname string) error {
old, err := ioutil.ReadFile(path) old, err := ioutil.ReadFile(path)
if err != nil { if err != nil {