refractored comment API

Author: lanrat

axfr.go

@@ -152,7 +152,7 @@ func axfrToFile(zone string, ip net.IP, nameserver string) (int64, error) {
 	v("saving zone %q to file %s", zone, filename)
 	zonefile := save.New(zone, filename)
 	defer func() {
-		err = zonefile.WriteComment("envelopes", fmt.Sprintf("%d", envelope))
+		err = zonefile.WriteCommentKey("envelopes", fmt.Sprintf("%d", envelope))
 		if err != nil {
 			panic(err)
 		}
@@ -161,20 +161,23 @@ func axfrToFile(zone string, ip net.IP, nameserver string) (int64, error) {
 			panic(err)
 		}
 	}()
-
-	err = zonefile.WriteComment("nameserver", nameserver)
+	err = zonefile.WriteComment("Generated by ALLXFR (https://github.com/lanrat/allxfr)\n")
+	if err != nil {
+		return zonefile.Records(), err
+	}
+	err = zonefile.WriteCommentKey("nameserver", nameserver)
 	if err != nil {
 		return zonefile.Records(), err
 	}
-	err = zonefile.WriteComment("nameserverIP", ip.String())
+	err = zonefile.WriteCommentKey("nameserverIP", ip.String())
 	if err != nil {
 		return zonefile.Records(), err
 	}
 	axfrType := "AXFR"
 	if *ixfr {
 		axfrType = "IXFR"
 	}
-	err = zonefile.WriteComment("xfr", axfrType)
+	err = zonefile.WriteCommentKey("xfr", axfrType)
 	if err != nil {
 		return zonefile.Records(), err
 	}

save/savezone.go

@@ -38,15 +38,20 @@ func (f *File) Records() int64 {
 }
 
 // WriteComment adds a comment to the zone file
-func (f *File) WriteComment(key, value string) error {
+func (f *File) WriteComment(comment string) error {
 	err := f.fileReady()
 	if err != nil {
 		return err
 	}
-	_, err = f.bufWriter.WriteString(fmt.Sprintf("; %s: %s\n", key, value))
+	_, err = f.bufWriter.WriteString(fmt.Sprintf("; %s", comment))
 	return err
 }
 
+// WriteCommentKey adds a comment to the zone file
+func (f *File) WriteCommentKey(key, value string) error {
+	return f.WriteComment(fmt.Sprintf("%s: %s\n", key, value))
+}
+
 // ErrFileClosed returned when attempting to write to a closed file
 var ErrFileClosed = errors.New("file is already closed")
 
@@ -65,18 +70,13 @@ func (f *File) fileReady() error {
 		f.gzWriter = gzip.NewWriter(f.fileWriter)
 		f.gzWriter.ModTime = time.Now()
 		f.gzWriter.Name = fmt.Sprintf("%s.zone", f.zone[:len(f.zone)-1])
-		f.gzWriter.Comment = "generated by allxfr"
 		f.bufWriter = bufio.NewWriter(f.gzWriter)
 		// Save metadata to zone file as comment
-		_, err = f.bufWriter.WriteString("; Generated by ALLXFR (https://github.com/lanrat/allxfr)\n")
-		if err != nil {
-			return err
-		}
-		err = f.WriteComment("timestamp", time.Now().Format(time.RFC3339))
+		err = f.WriteCommentKey("timestamp", time.Now().Format(time.RFC3339))
 		if err != nil {
 			return err
 		}
-		err = f.WriteComment("zone", f.zone)
+		err = f.WriteCommentKey("zone", f.zone)
 		if err != nil {
 			return err
 		}
@@ -105,7 +105,7 @@ func (f *File) Finish() error {
 	// function to finish/close/safe the files when done
 	if f.records > 1 {
 		// save record count comment at end of zone file
-		err := f.WriteComment("records", fmt.Sprintf("%d", f.records))
+		err := f.WriteCommentKey("records", fmt.Sprintf("%d", f.records))
 		if err != nil {
 			return err
 		}