File: storage_buckets.go

package info (click to toggle)
incus 6.0.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 24,392 kB
  • sloc: sh: 16,313; ansic: 3,121; python: 457; makefile: 337; ruby: 51; sql: 50; lisp: 6
file content (659 lines) | stat: -rw-r--r-- 18,932 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
//go:build linux && cgo && !agent

package db

import (
	"context"
	"database/sql"
	"errors"
	"fmt"
	"net/http"
	"strings"

	dqliteDriver "github.com/cowsql/go-cowsql/driver"

	"github.com/lxc/incus/v6/internal/server/db/query"
	"github.com/lxc/incus/v6/internal/version"
	"github.com/lxc/incus/v6/shared/api"
)

// StorageBucketFilter used for filtering storage buckets with GetStorageBuckets().
type StorageBucketFilter struct {
	PoolID   *int64
	PoolName *string
	Project  *string
	Name     *string
}

// StorageBucket represents a database storage bucket record.
type StorageBucket struct {
	api.StorageBucket

	ID       int64
	PoolID   int64
	PoolName string
}

// GetStoragePoolBuckets returns all storage buckets.
// If there are no buckets, it returns an empty list and no error.
// Accepts filters for narrowing down the results returned. If memberSpecific is true, then the search is
// restricted to buckets that belong to this member or belong to all members.
func (c *ClusterTx) GetStoragePoolBuckets(ctx context.Context, memberSpecific bool, filters ...StorageBucketFilter) ([]*StorageBucket, error) {
	var q *strings.Builder = &strings.Builder{}
	var args []any

	q.WriteString(`
	SELECT
		projects.name as project,
		storage_pools.name,
		storage_buckets.id,
		storage_buckets.storage_pool_id,
		storage_buckets.name,
		storage_buckets.description,
		IFNULL(nodes.name, "") as location
	FROM storage_buckets
	JOIN projects ON projects.id = storage_buckets.project_id
	JOIN storage_pools ON storage_pools.id = storage_buckets.storage_pool_id
	LEFT JOIN nodes ON nodes.id = storage_buckets.node_id
	`)

	if memberSpecific {
		if len(args) == 0 {
			q.WriteString("WHERE ")
		} else {
			q.WriteString("AND ")
		}

		q.WriteString("(storage_buckets.node_id = ? OR storage_buckets.node_id IS NULL) ")
		args = append(args, c.nodeID)
	}

	if len(filters) > 0 {
		if len(args) == 0 {
			q.WriteString("WHERE (")
		} else {
			q.WriteString("AND (")
		}

		for i, filter := range filters {
			// Validate filter.
			if !memberSpecific && filter.Name != nil && ((filter.PoolID == nil && filter.PoolName == nil) || filter.Project == nil) {
				return nil, errors.New("Cannot filter by bucket name without specifying pool and project when doing member inspecific search")
			}

			var qFilters []string

			if filter.PoolID != nil {
				qFilters = append(qFilters, "storage_buckets.storage_pool_id= ?")
				args = append(args, *filter.PoolID)
			}

			if filter.PoolName != nil {
				qFilters = append(qFilters, "storage_pools.name= ?")
				args = append(args, *filter.PoolID)
			}

			if filter.Project != nil {
				qFilters = append(qFilters, "projects.name = ?")
				args = append(args, *filter.Project)
			}

			if filter.Name != nil {
				qFilters = append(qFilters, "storage_buckets.name = ?")
				args = append(args, *filter.Name)
			}

			if qFilters == nil {
				return nil, errors.New("Invalid storage bucket filter")
			}

			if i > 0 {
				q.WriteString(" OR ")
			}

			q.WriteString(fmt.Sprintf("(%s)", strings.Join(qFilters, " AND ")))
		}

		q.WriteString(")")
	}

	var err error
	var buckets []*StorageBucket

	err = query.Scan(ctx, c.Tx(), q.String(), func(scan func(dest ...any) error) error {
		var bucket StorageBucket

		err := scan(&bucket.Project, &bucket.PoolName, &bucket.ID, &bucket.PoolID, &bucket.Name, &bucket.Description, &bucket.Location)
		if err != nil {
			return err
		}

		buckets = append(buckets, &bucket)

		return nil
	}, args...)
	if err != nil {
		return nil, err
	}

	// Populate config.
	for i := range buckets {
		err = storagePoolBucketConfig(ctx, c, buckets[i].ID, &buckets[i].StorageBucket)
		if err != nil {
			return nil, err
		}
	}

	return buckets, nil
}

// storagePoolBucketConfig populates the config map of the Storage Bucket with the given ID.
func storagePoolBucketConfig(ctx context.Context, tx *ClusterTx, bucketID int64, bucket *api.StorageBucket) error {
	q := `
	SELECT
		key,
		value
	FROM storage_buckets_config
	WHERE storage_bucket_id=?
	`

	bucket.Config = make(map[string]string)
	return query.Scan(ctx, tx.Tx(), q, func(scan func(dest ...any) error) error {
		var key, value string

		err := scan(&key, &value)
		if err != nil {
			return err
		}

		_, found := bucket.Config[key]
		if found {
			return fmt.Errorf("Duplicate config row found for key %q for storage bucket ID %d", key, bucketID)
		}

		bucket.Config[key] = value

		return nil
	}, bucketID)
}

// GetStoragePoolBucket returns the Storage Bucket for the given Storage Pool ID, Project Name and Bucket Name.
// If memberSpecific is true, then the search is restricted to buckets that belong to this member or belong
// to all members.
func (c *ClusterTx) GetStoragePoolBucket(ctx context.Context, poolID int64, projectName string, memberSpecific bool, bucketName string) (*StorageBucket, error) {
	filters := []StorageBucketFilter{{
		PoolID:  &poolID,
		Project: &projectName,
		Name:    &bucketName,
	}}

	buckets, err := c.GetStoragePoolBuckets(ctx, memberSpecific, filters...)
	bucketsLen := len(buckets)
	if (err == nil && bucketsLen <= 0) || errors.Is(err, sql.ErrNoRows) {
		return nil, api.StatusErrorf(http.StatusNotFound, "Storage bucket not found")
	} else if err == nil && bucketsLen > 1 {
		return nil, api.StatusErrorf(http.StatusConflict, "Storage bucket found on more than one cluster member. Please target a specific member")
	} else if err != nil {
		return nil, err
	}

	return buckets[0], nil
}

// GetStoragePoolLocalBucket returns the local Storage Bucket for the given bucket name.
// The search is restricted to buckets that belong to this member.
func (c *ClusterTx) GetStoragePoolLocalBucket(ctx context.Context, bucketName string) (*StorageBucket, error) {
	filters := []StorageBucketFilter{{
		Name: &bucketName,
	}}

	buckets, err := c.GetStoragePoolBuckets(ctx, true, filters...)
	if err != nil && !errors.Is(err, sql.ErrNoRows) {
		return nil, err
	}

	for _, bucket := range buckets {
		if bucket.Location == "" {
			continue // Ignore buckets on remote storage pools.
		}

		return bucket, nil
	}

	return nil, api.StatusErrorf(http.StatusNotFound, "Storage bucket not found")
}

// GetStoragePoolLocalBucketByAccessKey returns the local Storage Bucket for the given bucket access key.
// The search is restricted to buckets that belong to this member.
func (c *ClusterTx) GetStoragePoolLocalBucketByAccessKey(ctx context.Context, accessKey string) (*StorageBucket, error) {
	var q *strings.Builder = &strings.Builder{}

	q.WriteString(`
	SELECT
		projects.name as project,
		storage_pools.name,
		storage_buckets.id,
		storage_buckets.storage_pool_id,
		storage_buckets.name,
		storage_buckets.description,
		IFNULL(nodes.name, "") as location
	FROM storage_buckets
	JOIN projects ON projects.id = storage_buckets.project_id
	JOIN storage_pools ON storage_pools.id = storage_buckets.storage_pool_id
	JOIN storage_buckets_keys ON storage_buckets_keys.storage_bucket_id = storage_buckets.id
	JOIN nodes ON nodes.id = storage_buckets.node_id
	WHERE storage_buckets.node_id = ?
	AND storage_buckets_keys.access_key = ?
	`)

	var err error
	var buckets []*StorageBucket
	args := []any{c.nodeID, accessKey}

	err = query.Scan(ctx, c.Tx(), q.String(), func(scan func(dest ...any) error) error {
		var bucket StorageBucket

		err := scan(&bucket.Project, &bucket.PoolName, &bucket.ID, &bucket.PoolID, &bucket.Name, &bucket.Description, &bucket.Location)
		if err != nil {
			return err
		}

		buckets = append(buckets, &bucket)

		return nil
	}, args...)
	if err != nil {
		return nil, err
	}

	bucketsLen := len(buckets)
	if bucketsLen == 1 {
		// Populate config.
		err = storagePoolBucketConfig(ctx, c, buckets[0].ID, &buckets[0].StorageBucket)
		if err != nil {
			return nil, err
		}

		return buckets[0], nil
	} else if bucketsLen > 1 {
		return nil, api.StatusErrorf(http.StatusConflict, "Multiple storage buckets found for access key")
	}

	return nil, api.StatusErrorf(http.StatusNotFound, "Storage bucket access key not found")
}

// CreateStoragePoolBucket creates a new Storage Bucket.
// If memberSpecific is true, then the storage bucket is associated to the current member, rather than being
// associated to all members.
func (c *ClusterTx) CreateStoragePoolBucket(ctx context.Context, poolID int64, projectName string, memberSpecific bool, info api.StorageBucketsPost) (int64, error) {
	var err error
	var bucketID int64
	var nodeID any

	if memberSpecific {
		nodeID = c.nodeID
	}

	// Insert a new Storage Bucket record.
	result, err := c.tx.ExecContext(ctx, `
		INSERT INTO storage_buckets
		(storage_pool_id, node_id, name, description, project_id)
		VALUES (?, ?, ?, ?, (SELECT id FROM projects WHERE name = ?))
		`, poolID, nodeID, info.Name, info.Description, projectName)
	if err != nil {
		var dqliteErr dqliteDriver.Error
		// Detect SQLITE_CONSTRAINT_UNIQUE (2067) errors.
		if errors.As(err, &dqliteErr) && dqliteErr.Code == 2067 {
			return -1, api.StatusErrorf(http.StatusConflict, "A bucket for that name already exists")
		}

		return -1, err
	}

	bucketID, err = result.LastInsertId()
	if err != nil {
		return -1, err
	}

	// Save config.
	err = storageBucketPoolConfigAdd(c.tx, bucketID, info.Config)
	if err != nil {
		return -1, err
	}

	return bucketID, err
}

// storageBucketPoolConfigAdd inserts Storage Bucket config keys.
func storageBucketPoolConfigAdd(tx *sql.Tx, bucketID int64, config map[string]string) error {
	stmt, err := tx.Prepare(`
	INSERT INTO storage_buckets_config
	(storage_bucket_id, key, value)
	VALUES(?, ?, ?)
	`)
	if err != nil {
		return err
	}

	defer func() { _ = stmt.Close() }()

	for k, v := range config {
		if v == "" {
			continue
		}

		_, err = stmt.Exec(bucketID, k, v)
		if err != nil {
			return fmt.Errorf("Failed inserting config: %w", err)
		}
	}

	return nil
}

// UpdateStoragePoolBucket updates an existing Storage Bucket.
func (c *ClusterTx) UpdateStoragePoolBucket(ctx context.Context, poolID int64, bucketID int64, info *api.StorageBucketPut) error {
	// Update existing Storage Bucket record.
	res, err := c.tx.ExecContext(ctx, `
		UPDATE storage_buckets
		SET description = ?
		WHERE storage_pool_id = ? and id = ?
		`, info.Description, poolID, bucketID)
	if err != nil {
		return err
	}

	rowsAffected, err := res.RowsAffected()
	if err != nil {
		return err
	}

	if rowsAffected <= 0 {
		return api.StatusErrorf(http.StatusNotFound, "Storage bucket not found")
	}

	// Save config.
	_, err = c.tx.ExecContext(ctx, "DELETE FROM storage_buckets_config WHERE storage_bucket_id=?", bucketID)
	if err != nil {
		return err
	}

	err = storageBucketPoolConfigAdd(c.tx, bucketID, info.Config)
	if err != nil {
		return err
	}

	return nil
}

// DeleteStoragePoolBucket deletes an existing Storage Bucket.
func (c *ClusterTx) DeleteStoragePoolBucket(ctx context.Context, poolID int64, bucketID int64) error {
	// Delete existing Storage Bucket record.
	res, err := c.tx.ExecContext(ctx, `
			DELETE FROM storage_buckets
			WHERE storage_pool_id = ? and id = ?
		`, poolID, bucketID)
	if err != nil {
		return err
	}

	rowsAffected, err := res.RowsAffected()
	if err != nil {
		return err
	}

	if rowsAffected <= 0 {
		return api.StatusErrorf(http.StatusNotFound, "Storage bucket not found")
	}

	return nil
}

// StorageBucketKeyFilter used for filtering storage bucket keys with GetStoragePoolBucketKeys().
type StorageBucketKeyFilter struct {
	Name *string
}

// StorageBucketKey represents a database storage bucket key record.
type StorageBucketKey struct {
	api.StorageBucketKey

	ID int64
}

// GetStoragePoolBucketKeys returns all storage buckets keys attached to a given storage bucket.
// If there are no bucket keys, it returns an empty list and no error.
// Accepts filters for narrowing down the results returned.
func (c *ClusterTx) GetStoragePoolBucketKeys(ctx context.Context, bucketID int64, filters ...StorageBucketKeyFilter) ([]*StorageBucketKey, error) {
	var q *strings.Builder = &strings.Builder{}
	args := []any{bucketID}

	q.WriteString(`
	SELECT
		storage_buckets_keys.id,
		storage_buckets_keys.name,
		storage_buckets_keys.description,
		storage_buckets_keys.role,
		storage_buckets_keys.access_key,
		storage_buckets_keys.secret_key
	FROM storage_buckets_keys
	WHERE storage_buckets_keys.storage_bucket_id = ?
	`)

	if len(filters) > 0 {
		q.WriteString("AND (")

		for i, filter := range filters {
			var qFilters []string

			if filter.Name != nil {
				qFilters = append(qFilters, "storage_buckets_keys.name = ?")
				args = append(args, *filter.Name)
			}

			if qFilters == nil {
				return nil, errors.New("Invalid storage bucket key filter")
			}

			if i > 0 {
				q.WriteString(" OR ")
			}

			q.WriteString(fmt.Sprintf("(%s)", strings.Join(qFilters, " AND ")))
		}

		q.WriteString(")")
	}

	var err error
	var bucketKeys []*StorageBucketKey

	err = query.Scan(ctx, c.Tx(), q.String(), func(scan func(dest ...any) error) error {
		var bucketKey StorageBucketKey

		err := scan(&bucketKey.ID, &bucketKey.Name, &bucketKey.Description, &bucketKey.Role, &bucketKey.AccessKey, &bucketKey.SecretKey)
		if err != nil {
			return err
		}

		bucketKeys = append(bucketKeys, &bucketKey)

		return nil
	}, args...)
	if err != nil {
		return nil, err
	}

	return bucketKeys, nil
}

// GetStoragePoolBucketKey returns the Storage Bucket Key for the given Bucket ID and Key Name.
func (c *ClusterTx) GetStoragePoolBucketKey(ctx context.Context, bucketID int64, keyName string) (*StorageBucketKey, error) {
	filters := []StorageBucketKeyFilter{{
		Name: &keyName,
	}}

	bucketKeys, err := c.GetStoragePoolBucketKeys(ctx, bucketID, filters...)
	bucketKeysLen := len(bucketKeys)
	if (err == nil && bucketKeysLen <= 0) || errors.Is(err, sql.ErrNoRows) {
		return nil, api.StatusErrorf(http.StatusNotFound, "Storage bucket key not found")
	} else if err == nil && bucketKeysLen > 1 {
		return nil, api.StatusErrorf(http.StatusConflict, "More than one storage bucket key found")
	} else if err != nil {
		return nil, err
	}

	return bucketKeys[0], nil
}

// CreateStoragePoolBucketKey creates a new Storage Bucket Key.
func (c *ClusterTx) CreateStoragePoolBucketKey(ctx context.Context, bucketID int64, info api.StorageBucketKeysPost) (int64, error) {
	var err error
	var bucketKeyID int64

	// Check there isn't another bucket with the same access key on the local server.
	bucket, err := c.GetStoragePoolLocalBucketByAccessKey(ctx, info.AccessKey)
	if err != nil && !api.StatusErrorCheck(err, http.StatusNotFound) {
		return -1, err
	} else if bucket != nil {
		return -1, api.StatusErrorf(http.StatusConflict, "A bucket key using that access key already exists on this server")
	}

	// Insert a new Storage Bucket Key record.
	result, err := c.tx.ExecContext(ctx, `
		INSERT INTO storage_buckets_keys
		(storage_bucket_id, name, description, role, access_key, secret_key)
		VALUES (?, ?, ?, ?, ?, ?)
		`, bucketID, info.Name, info.Description, info.Role, info.AccessKey, info.SecretKey)
	if err != nil {
		var dqliteErr dqliteDriver.Error
		// Detect SQLITE_CONSTRAINT_UNIQUE (2067) errors.
		if errors.As(err, &dqliteErr) && dqliteErr.Code == 2067 {
			return -1, api.StatusErrorf(http.StatusConflict, "A bucket key for that name already exists")
		}

		return -1, err
	}

	bucketKeyID, err = result.LastInsertId()
	if err != nil {
		return -1, err
	}

	return bucketKeyID, err
}

// UpdateStoragePoolBucketKey updates an existing Storage Bucket Key.
func (c *ClusterTx) UpdateStoragePoolBucketKey(ctx context.Context, bucketID int64, bucketKeyID int64, info *api.StorageBucketKeyPut) error {
	// Check there isn't another bucket with the same access key on the local server.
	bucket, err := c.GetStoragePoolLocalBucketByAccessKey(ctx, info.AccessKey)
	if err != nil && !api.StatusErrorCheck(err, http.StatusNotFound) {
		return err
	} else if bucket != nil && bucket.ID != bucketID {
		return api.StatusErrorf(http.StatusConflict, "A bucket key using that access key already exists on this server")
	}

	// Update existing Storage Bucket Key record.
	res, err := c.tx.ExecContext(ctx, `
		UPDATE storage_buckets_keys
		SET description = ?, role = ?, access_key = ?, secret_key = ?
		WHERE storage_bucket_id = ? and id = ?
		`, info.Description, info.Role, info.AccessKey, info.SecretKey, bucketID, bucketKeyID)
	if err != nil {
		return err
	}

	rowsAffected, err := res.RowsAffected()
	if err != nil {
		return err
	}

	if rowsAffected <= 0 {
		return api.StatusErrorf(http.StatusNotFound, "Storage bucket key not found")
	}

	return nil
}

// DeleteStoragePoolBucketKey deletes an existing Storage Bucket Key.
func (c *ClusterTx) DeleteStoragePoolBucketKey(ctx context.Context, bucketID int64, keyID int64) error {
	// Delete existing Storage Bucket record.
	res, err := c.tx.ExecContext(ctx, `
			DELETE FROM storage_buckets_keys
			WHERE storage_bucket_id = ? and id = ?
		`, bucketID, keyID)
	if err != nil {
		return err
	}

	rowsAffected, err := res.RowsAffected()
	if err != nil {
		return err
	}

	if rowsAffected <= 0 {
		return api.StatusErrorf(http.StatusNotFound, "Storage bucket key not found")
	}

	return nil
}

// GetStoragePoolBucketWithID returns the volume with the given ID.
func (c *ClusterTx) GetStoragePoolBucketWithID(ctx context.Context, bucketID int) (StorageBucket, error) {
	var response StorageBucket

	stmt := `
SELECT
	projects.name as project,
	storage_pools.name,
	storage_buckets.id,
	storage_buckets.storage_pool_id,
	storage_buckets.name,
	storage_buckets.description,
	IFNULL(nodes.name, "") as location
FROM storage_buckets
JOIN projects ON projects.id = storage_buckets.project_id
JOIN storage_pools ON storage_pools.id = storage_buckets.storage_pool_id
LEFT JOIN nodes ON nodes.id = storage_buckets.node_id
WHERE storage_buckets.id = ?
`

	err := c.tx.QueryRowContext(ctx, stmt, bucketID).Scan(&response.Project, &response.PoolName, &response.ID, &response.PoolID, &response.Name, &response.Description, &response.Location)
	if err != nil {
		if errors.Is(err, sql.ErrNoRows) {
			return StorageBucket{}, api.StatusErrorf(http.StatusNotFound, "Storage pool bucket not found")
		}

		return StorageBucket{}, err
	}

	response.Config, err = c.storageVolumeConfigGet(ctx, response.ID, false)
	if err != nil {
		return StorageBucket{}, err
	}

	return response, nil
}

// GetStorageBucketURIs returns the URIs of the storage buckets, specifying
// target node if applicable.
func (c *ClusterTx) GetStorageBucketURIs(ctx context.Context, project string) ([]string, error) {
	filter := StorageBucketFilter{Project: &project}
	bucketInfo, err := c.GetStoragePoolBuckets(ctx, false, filter)
	if err != nil {
		return nil, err
	}

	uris := []string{}
	for _, info := range bucketInfo {
		uri := api.NewURL().Path(version.APIVersion, "storage-pools", info.PoolName, "buckets", info.Name).Project(project)

		if info.Location != "" {
			uri.Target(info.Location)
		}

		uris = append(uris, uri.String())
	}

	return uris, nil
}