Skip to content
This repository was archived by the owner on Mar 4, 2025. It is now read-only.

Commit f6f8382

Browse files
justincliftjustinclift
committed
all: Minor code cleanups
Mostly getting rid of the \n in log.Print*() format strings, which don't need it.
1 parent ae5a000 commit f6f8382

File tree

16 files changed

+461
-470
lines changed

16 files changed

+461
-470
lines changed

‎api/handlers.go

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ func branchesHandler(w http.ResponseWriter, r *http.Request) {
5454
// Return the list as JSON
5555
jsonList, err := json.MarshalIndent(brList, "", " ")
5656
if err != nil {
57-
errMsg := fmt.Sprintf("Error when JSON marshalling the branch list: %v\n", err)
57+
errMsg := fmt.Sprintf("Error when JSON marshalling the branch list: %v", err)
5858
log.Print(errMsg)
5959
jsonErr(w, errMsg, http.StatusBadRequest)
6060
return
@@ -205,7 +205,7 @@ func columnsHandler(w http.ResponseWriter, r *http.Request) {
205205
// Return the results
206206
jsonData, err := json.MarshalIndent(jsonCols, "", " ")
207207
if err != nil {
208-
log.Printf("Error when JSON marshalling returned data in columnsHandler(): %v\n", err)
208+
log.Printf("Error when JSON marshalling returned data in columnsHandler(): %v", err)
209209
jsonErr(w, err.Error(), http.StatusInternalServerError)
210210
return
211211
}
@@ -248,7 +248,7 @@ func commitsHandler(w http.ResponseWriter, r *http.Request) {
248248
// Return the tags as JSON
249249
jsonData, err := json.MarshalIndent(commits, "", " ")
250250
if err != nil {
251-
log.Printf("Error when JSON marshalling returned data in commitsHandler(): %v\n", err)
251+
log.Printf("Error when JSON marshalling returned data in commitsHandler(): %v", err)
252252
jsonErr(w, err.Error(), http.StatusInternalServerError)
253253
return
254254
}
@@ -306,7 +306,7 @@ func databasesHandler(w http.ResponseWriter, r *http.Request) {
306306
// Return the results
307307
jsonData, err := json.MarshalIndent(list, "", " ")
308308
if err != nil {
309-
log.Printf("Error when JSON marshalling returned data in databasesHandler(): %v\n", err)
309+
log.Printf("Error when JSON marshalling returned data in databasesHandler(): %v", err)
310310
jsonErr(w, err.Error(), http.StatusInternalServerError)
311311
return
312312
}
@@ -571,7 +571,7 @@ func diffHandler(w http.ResponseWriter, r *http.Request) {
571571
// Return the results
572572
jsonData, err := json.MarshalIndent(diffs, "", " ")
573573
if err != nil {
574-
log.Printf("Error when JSON marshalling returned data in diffHandler(): %v\n", err)
574+
log.Printf("Error when JSON marshalling returned data in diffHandler(): %v", err)
575575
jsonErr(w, err.Error(), http.StatusInternalServerError)
576576
return
577577
}
@@ -687,7 +687,7 @@ func executeHandler(w http.ResponseWriter, r *http.Request) {
687687
z := com.ExecuteResponseContainer{RowsChanged: rowsChanged, Status: "OK"}
688688
jsonData, err := json.MarshalIndent(z, "", " ")
689689
if err != nil {
690-
log.Printf("Error when JSON marshalling returned data in executeHandler(): %v\n", err)
690+
log.Printf("Error when JSON marshalling returned data in executeHandler(): %v", err)
691691
jsonErr(w, err.Error(), http.StatusInternalServerError)
692692
return
693693
}
@@ -810,7 +810,7 @@ func indexesHandler(w http.ResponseWriter, r *http.Request) {
810810
// Return the results
811811
jsonData, err := json.MarshalIndent(indexes, "", " ")
812812
if err != nil {
813-
log.Printf("Error when JSON marshalling returned data in indexesHandler(): %v\n", err)
813+
log.Printf("Error when JSON marshalling returned data in indexesHandler(): %v", err)
814814
jsonErr(w, err.Error(), http.StatusInternalServerError)
815815
return
816816
}
@@ -853,7 +853,7 @@ func metadataHandler(w http.ResponseWriter, r *http.Request) {
853853
// Return the list as JSON
854854
jsonList, err := json.MarshalIndent(meta, "", " ")
855855
if err != nil {
856-
errMsg := fmt.Sprintf("Error when JSON marshalling the metadata: %v\n", err)
856+
errMsg := fmt.Sprintf("Error when JSON marshalling the metadata: %v", err)
857857
log.Print(errMsg)
858858
jsonErr(w, errMsg, http.StatusBadRequest)
859859
return
@@ -933,7 +933,7 @@ func queryHandler(w http.ResponseWriter, r *http.Request) {
933933
// Send the query to the appropriate backend live node
934934
data, err = com.LiveQueryDB(com.AmqpChan, liveNode, loggedInUser, dbOwner, dbName, query)
935935
if err != nil {
936-
log.Println(err) // FIXME: Debug output while developing
936+
log.Println(err)
937937
jsonErr(w, err.Error(), http.StatusInternalServerError)
938938
return
939939
}
@@ -942,7 +942,7 @@ func queryHandler(w http.ResponseWriter, r *http.Request) {
942942
// Return the results
943943
jsonData, err := json.MarshalIndent(data.Records, "", " ")
944944
if err != nil {
945-
jsonErr(w, fmt.Sprintf("Error when JSON marshalling the returned data: %v\n", err),
945+
jsonErr(w, fmt.Sprintf("Error when JSON marshalling the returned data: %v", err),
946946
http.StatusBadRequest)
947947
return
948948
}
@@ -985,7 +985,7 @@ func releasesHandler(w http.ResponseWriter, r *http.Request) {
985985
// Return the list as JSON
986986
jsonData, err := json.MarshalIndent(rels, "", " ")
987987
if err != nil {
988-
log.Printf("Error when JSON marshalling returned data in releasesHandler(): %v\n", err)
988+
log.Printf("Error when JSON marshalling returned data in releasesHandler(): %v", err)
989989
jsonErr(w, err.Error(), http.StatusInternalServerError)
990990
return
991991
}
@@ -1092,7 +1092,7 @@ func tablesHandler(w http.ResponseWriter, r *http.Request) {
10921092
sort.Strings(tables)
10931093
jsonData, err := json.MarshalIndent(tables, "", " ")
10941094
if err != nil {
1095-
log.Printf("Error when JSON marshalling returned data in tablesHandler(): %v\n", err)
1095+
log.Printf("Error when JSON marshalling returned data in tablesHandler(): %v", err)
10961096
jsonErr(w, err.Error(), http.StatusInternalServerError)
10971097
return
10981098
}
@@ -1135,7 +1135,7 @@ func tagsHandler(w http.ResponseWriter, r *http.Request) {
11351135
// Return the tags as JSON
11361136
jsonData, err := json.MarshalIndent(tags, "", " ")
11371137
if err != nil {
1138-
log.Printf("Error when JSON marshalling returned data in tagsHandler(): %v\n", err)
1138+
log.Printf("Error when JSON marshalling returned data in tagsHandler(): %v", err)
11391139
jsonErr(w, err.Error(), http.StatusInternalServerError)
11401140
return
11411141
}
@@ -1199,11 +1199,10 @@ func uploadHandler(w http.ResponseWriter, r *http.Request) {
11991199
// Check whether the uploaded database is too large
12001200
if !oversizeAllowed {
12011201
if r.ContentLength > (com.MaxDatabaseSize * 1024 * 1024) {
1202-
jsonErr(w,
1203-
fmt.Sprintf("Database is too large. Maximum database upload size is %d MB, yours is %d MB",
1204-
com.MaxDatabaseSize, r.ContentLength/1024/1024), http.StatusBadRequest)
1205-
log.Println(fmt.Sprintf("'%s' attempted to upload an oversized database %d MB in size. Limit is %d MB\n",
1206-
loggedInUser, r.ContentLength/1024/1024, com.MaxDatabaseSize))
1202+
jsonErr(w, fmt.Sprintf("Database is too large. Maximum database upload size is %d MB, yours is %d MB",
1203+
com.MaxDatabaseSize, r.ContentLength/1024/1024), http.StatusBadRequest)
1204+
log.Printf("'%s' attempted to upload an oversized database %d MB in size. Limit is %d MB",
1205+
loggedInUser, r.ContentLength/1024/1024, com.MaxDatabaseSize)
12071206
return
12081207
}
12091208
}
@@ -1344,7 +1343,7 @@ func uploadHandler(w http.ResponseWriter, r *http.Request) {
13441343
z := com.UploadResponseContainer{CommitID: newCommit, URL: newURL}
13451344
jsonData, err := json.MarshalIndent(z, "", " ")
13461345
if err != nil {
1347-
log.Printf("Error when JSON marshalling returned data in uploadHandler(): %v\n", err)
1346+
log.Printf("Error when JSON marshalling returned data in uploadHandler(): %v", err)
13481347
jsonErr(w, err.Error(), http.StatusInternalServerError)
13491348
return
13501349
}
@@ -1426,7 +1425,7 @@ func viewsHandler(w http.ResponseWriter, r *http.Request) {
14261425
sort.Strings(views)
14271426
jsonData, err := json.MarshalIndent(views, "", " ")
14281427
if err != nil {
1429-
log.Printf("Error when JSON marshalling returned data in viewsHandler(): %v\n", err)
1428+
log.Printf("Error when JSON marshalling returned data in viewsHandler(): %v", err)
14301429
jsonErr(w, err.Error(), http.StatusInternalServerError)
14311430
return
14321431
}
@@ -1453,7 +1452,7 @@ func webpageHandler(w http.ResponseWriter, r *http.Request) {
14531452
z.WebPage = "https://" + com.Conf.Web.ServerName + "/" + dbOwner + "/" + dbName
14541453
jsonData, err := json.MarshalIndent(z, "", " ")
14551454
if err != nil {
1456-
log.Printf("Error when JSON marshalling returned data in webpageHandler(): %v\n", err)
1455+
log.Printf("Error when JSON marshalling returned data in webpageHandler(): %v", err)
14571456
jsonErr(w, err.Error(), http.StatusInternalServerError)
14581457
return
14591458
}

‎api/main.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ func main() {
5353
// Open the request log for writing
5454
reqLog, err = os.OpenFile(com.Conf.Api.RequestLog, os.O_CREATE|os.O_APPEND|os.O_WRONLY|os.O_SYNC, 0750)
5555
if err != nil {
56-
log.Fatalf("Error when opening request log: %s\n", err)
56+
log.Fatalf("Error when opening request log: %s", err)
5757
}
5858
defer reqLog.Close()
59-
log.Printf("Request log opened: %s\n", com.Conf.Api.RequestLog)
59+
log.Printf("Request log opened: %s", com.Conf.Api.RequestLog)
6060

6161
// Parse our template files
6262
tmpl = template.Must(template.New("templates").Delims("[[", "]]").ParseGlob(
@@ -103,12 +103,12 @@ func main() {
103103
ourCAPool = x509.NewCertPool()
104104
certFile, err := os.ReadFile(com.Conf.DB4S.CAChain)
105105
if err != nil {
106-
fmt.Printf("Error opening Certificate Authority chain file: %v\n", err)
106+
log.Printf("Error opening Certificate Authority chain file: %v", err)
107107
return
108108
}
109109
ok := ourCAPool.AppendCertsFromPEM(certFile)
110110
if !ok {
111-
fmt.Println("Error appending certificate file")
111+
log.Println("Error appending certificate file")
112112
return
113113
}
114114

@@ -159,7 +159,7 @@ func main() {
159159
server = fmt.Sprintf("https://%s", com.Conf.Api.ServerName)
160160

161161
// Start API server
162-
log.Printf("API server starting on %s\n", server)
162+
log.Printf("API server starting on %s", server)
163163
err = srv.ListenAndServeTLS(com.Conf.Api.Certificate, com.Conf.Api.CertificateKey)
164164

165165
// Shut down nicely
@@ -283,7 +283,7 @@ func collectInfoAndOpen(w http.ResponseWriter, r *http.Request) (sdb *sqlite.Con
283283
return
284284
}
285285
if err = sdb.EnableExtendedResultCodes(true); err != nil {
286-
log.Printf("Couldn't enable extended result codes in collectInfoAndOpen(): %v\n", err.Error())
286+
log.Printf("Couldn't enable extended result codes in collectInfoAndOpen(): %v", err.Error())
287287
httpStatus = http.StatusInternalServerError
288288
return
289289
}
@@ -320,7 +320,7 @@ func extractUserFromClientCert(w http.ResponseWriter, r *http.Request) (userAcc
320320
// Verify the running server matches the one in the certificate
321321
db4sServer := com.Conf.DB4S.Server
322322
if certServer != db4sServer {
323-
err = fmt.Errorf("Server name in certificate '%s' doesn't match DB4S server '%s'\n", certServer,
323+
err = fmt.Errorf("Server name in certificate '%s' doesn't match DB4S server '%s'", certServer,
324324
db4sServer)
325325
return
326326
}
@@ -348,7 +348,7 @@ func jsonErr(w http.ResponseWriter, msg string, statusCode int) {
348348
}
349349
jsonData, err := json.MarshalIndent(je, "", " ")
350350
if err != nil {
351-
errMsg := fmt.Sprintf("A 2nd error occurred when JSON marshalling an error structure: %v\n", err)
351+
errMsg := fmt.Sprintf("A 2nd error occurred when JSON marshalling an error structure: %v", err)
352352
log.Print(errMsg)
353353
http.Error(w, errMsg, http.StatusInternalServerError)
354354
fmt.Fprintf(w, `{"error":"An error occurred when marshalling JSON inside jsonErr()"}`)

‎common/cert.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,78 +38,78 @@ func GenerateClientCert(userName string) (_ []byte, err error) {
3838
serialNumLimit := new(big.Int).Lsh(big.NewInt(1), 128)
3939
newCert.SerialNumber, err = rand.Int(rand.Reader, serialNumLimit)
4040
if err != nil {
41-
log.Printf("%s: Error when generating serial number: %v\n", pageName, err)
41+
log.Printf("%s: Error when generating serial number: %v", pageName, err)
4242
return nil, err
4343
}
4444

4545
// Load the certificate used for signing (the intermediate certificate)
4646
certFile, err := os.ReadFile(Conf.Sign.IntermediateCert)
4747
if err != nil {
48-
log.Printf("%s: Error opening intermediate certificate file: %v\n", pageName, err)
48+
log.Printf("%s: Error opening intermediate certificate file: %v", pageName, err)
4949
return
5050
}
5151
certPEM, _ := pem.Decode(certFile)
5252
if certPEM == nil {
53-
log.Printf("%s: Error when PEM decoding the intermediate certificate file\n", pageName)
53+
log.Printf("%s: Error when PEM decoding the intermediate certificate file", pageName)
5454
return
5555
}
5656
intCert, err := x509.ParseCertificate(certPEM.Bytes)
5757
if err != nil {
58-
log.Printf("%s: Error when parsing decoded intermediate certificate data: %v\n", pageName, err)
58+
log.Printf("%s: Error when parsing decoded intermediate certificate data: %v", pageName, err)
5959
return
6060
}
6161

6262
// Load the private key for the intermediate certificate
6363
intKeyFile, err := os.ReadFile(Conf.Sign.IntermediateKey)
6464
if err != nil {
65-
log.Printf("%s: Error opening intermediate certificate key: %v\n", pageName, err)
65+
log.Printf("%s: Error opening intermediate certificate key: %v", pageName, err)
6666
return
6767
}
6868
intKeyPEM, _ := pem.Decode(intKeyFile)
6969
if certPEM == nil {
70-
log.Printf("%s: Error when PEM decoding the intermediate key file\n", pageName)
70+
log.Printf("%s: Error when PEM decoding the intermediate key file", pageName)
7171
return
7272
}
7373
intKey, err := x509.ParsePKCS1PrivateKey(intKeyPEM.Bytes)
7474
if err != nil {
75-
log.Printf("%s: Error when parsing intermediate certificate key: %v\n", pageName, err)
75+
log.Printf("%s: Error when parsing intermediate certificate key: %v", pageName, err)
7676
return
7777
}
7878

7979
// Generate a public key to sign the new certificate with
8080
clientKey, err := rsa.GenerateKey(rand.Reader, 2048)
8181
if err != nil {
82-
log.Printf("%s: Failed to public key for signing: %v\n", pageName, err)
82+
log.Printf("%s: Failed to public key for signing: %v", pageName, err)
8383
return
8484
}
8585

8686
// Generate the new certificate
8787
clientCert, err := x509.CreateCertificate(rand.Reader, &newCert, intCert, &clientKey.PublicKey, intKey)
8888
if err != nil {
89-
log.Printf("%s: Failed to create certificate: %v\n", pageName, err)
89+
log.Printf("%s: Failed to create certificate: %v", pageName, err)
9090
return
9191
}
9292

9393
// Convert the new certificate into PEM format
9494
buf := &bytes.Buffer{}
9595
err = pem.Encode(buf, &pem.Block{Type: "CERTIFICATE", Bytes: clientCert})
9696
if err != nil {
97-
log.Printf("%s: Failed to PEM encode certificate: %v\n", pageName, err)
97+
log.Printf("%s: Failed to PEM encode certificate: %v", pageName, err)
9898
return
9999
}
100100

101101
// Convert the private key for the certificate into PEM format
102102
buf2 := &bytes.Buffer{}
103103
err = pem.Encode(buf2, &pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(clientKey)})
104104
if err != nil {
105-
log.Printf("%s: Failed to PEM encode private key: %v\n", pageName, err)
105+
log.Printf("%s: Failed to PEM encode private key: %v", pageName, err)
106106
return
107107
}
108108

109109
// Concatenate the newly generated certificate and its key
110110
_, err = buf.ReadFrom(buf2)
111111
if err != nil {
112-
log.Printf("%s: Failed to concatenate the PEM blocks: %v\n", pageName, err)
112+
log.Printf("%s: Failed to concatenate the PEM blocks: %v", pageName, err)
113113
return
114114
}
115115

‎common/diff.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ func dbDiff(dbA string, dbB string, merge MergeStrategy, includeData bool) (Diff
134134
}
135135
defer sdb.Close()
136136
if err = sdb.EnableExtendedResultCodes(true); err != nil {
137-
log.Printf("Couldn't enable extended result codes in dbDiff(): %v\n", err.Error())
137+
log.Printf("Couldn't enable extended result codes in dbDiff(): %v", err.Error())
138138
return Diffs{}, err
139139
}
140140

@@ -152,7 +152,7 @@ func dbDiff(dbA string, dbB string, merge MergeStrategy, includeData bool) (Diff
152152
"SELECT name, type FROM aux.sqlite_master WHERE name NOT LIKE 'sqlite_%' AND (type != 'table' OR (type = 'table' AND sql NOT LIKE 'CREATE VIRTUAL%%'))\n" +
153153
" ORDER BY name")
154154
if err != nil {
155-
log.Printf("Error when preparing statement for object list in dbDiff(): %s\n", err)
155+
log.Printf("Error when preparing statement for object list in dbDiff(): %s", err)
156156
return Diffs{}, err
157157
}
158158
defer stmt.Finalize()
@@ -169,7 +169,7 @@ func dbDiff(dbA string, dbB string, merge MergeStrategy, includeData bool) (Diff
169169
return nil
170170
})
171171
if err != nil {
172-
log.Printf("Error when diffing single object in dbDiff: %s\n", err)
172+
log.Printf("Error when diffing single object in dbDiff: %s", err)
173173
return Diffs{}, err
174174
}
175175

@@ -319,7 +319,7 @@ func dataDiffForAllTableRows(sdb *sqlite.Conn, schemaName string, tableName stri
319319
// Retrieve data and add it to the data diff object
320320
_, _, data, err := SQLiteRunQuery(sdb, QuerySourceInternal, query, false, false)
321321
if err != nil {
322-
log.Printf("Error getting rows in dataDiffForAllTableRows(): %s\n", err)
322+
log.Printf("Error getting rows in dataDiffForAllTableRows(): %s", err)
323323
return nil, err
324324
}
325325
for _, row := range data.Records {
@@ -504,7 +504,7 @@ func dataDiffForModifiedTableRows(sdb *sqlite.Conn, tableName string, merge Merg
504504
// Retrieve data and generate a new DataDiff object for each row
505505
_, _, data, err := SQLiteRunQuery(sdb, QuerySourceInternal, query, false, false)
506506
if err != nil {
507-
log.Printf("Error getting rows in dataDiffForModifiedTableRows(): %s\n", err)
507+
log.Printf("Error getting rows in dataDiffForModifiedTableRows(): %s", err)
508508
return nil, err
509509
}
510510
for _, row := range data.Records {

‎common/live.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,23 +55,23 @@ func ConnectMQ() (channel *amqp.Channel, err error) {
5555
if err != nil {
5656
return
5757
}
58-
log.Printf("%s connected to AMQP server using mutual TLS (mTLS): %v:%d\n", Conf.Live.Nodename, Conf.MQ.Server, Conf.MQ.Port)
58+
log.Printf("%s connected to AMQP server using mutual TLS (mTLS): %v:%d", Conf.Live.Nodename, Conf.MQ.Server, Conf.MQ.Port)
5959
} else {
6060
// Fallback to just verifying the server certs for TLS. This is needed by the DB4S end point, as it
6161
// uses certs from our own CA, so mTLS won't easily work with it.
6262
conn, err = amqp.Dial(fmt.Sprintf("amqps://%s:%s@%s:%d/", Conf.MQ.Username, Conf.MQ.Password, Conf.MQ.Server, Conf.MQ.Port))
6363
if err != nil {
6464
return
6565
}
66-
log.Printf("%s connected to AMQP server with server-only TLS: %v:%d\n", Conf.Live.Nodename, Conf.MQ.Server, Conf.MQ.Port)
66+
log.Printf("%s connected to AMQP server with server-only TLS: %v:%d", Conf.Live.Nodename, Conf.MQ.Server, Conf.MQ.Port)
6767
}
6868
} else {
6969
// Everywhere else (eg docker container) doesn't *have* to use TLS
7070
conn, err = amqp.Dial(fmt.Sprintf("amqp://%s:%s@%s:%d/", Conf.MQ.Username, Conf.MQ.Password, Conf.MQ.Server, Conf.MQ.Port))
7171
if err != nil {
7272
return
7373
}
74-
log.Printf("%s connected to AMQP server without encryption: %v:%d\n", Conf.Live.Nodename, Conf.MQ.Server, Conf.MQ.Port)
74+
log.Printf("%s connected to AMQP server without encryption: %v:%d", Conf.Live.Nodename, Conf.MQ.Server, Conf.MQ.Port)
7575
}
7676

7777
channel, err = conn.Channel()

‎common/memcache.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ func ConnectCache() error {
5858
}
5959

6060
// Log successful connection message for Memcached
61-
log.Printf("Connected to Memcached: %v\n", Conf.Memcache.Server)
61+
log.Printf("Connected to Memcached: %v", Conf.Memcache.Server)
6262

6363
return nil
6464
}

0 commit comments

Comments
 (0)